# ext-psi
[](https://gitter.im/m6w6/ext-psi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
[](https://travis-ci.org/m6w6/ext-psi)
PSI is a PHP extension, which provides a foreign function interface through
The acronym PSI may be read as:
* PHP System Interface
-* POSIX Standard Interface
-
-The latter because PSI can be configured to include declarations for most of the
-[base definitions and system interfaces of POSIX.1-2008](http://pubs.opengroup.org/onlinepubs/9699919799/).
> **WARNING:**
-> This is heavy WIP. Only a small part of configuration and implementation has been completed yet.
+> This is heavy WIP.
## Features
-* standard scalar types mapped to stdint types
* structs, unions, enums and typedefs
-* simple numeric expressions
-* string and int constants
+* numeric and boolean expressions
+* scalar constants
* vararg calls
## Installing
> **WARNING:**
-> This is heavy WIP. Installation only works from a source checkout yet.
+> This is heavy WIP. Installation only works from a source checkout with php-src@master yet.
### PECL
This is only relevant for an in-tree build. Use `--enable-psi` to include
the PSI extension in the build.
-### --enable-psi-posix
-**Pre-define POSIX decls.**
-
-Use `--enable-psi-posix=all` to enable all available POSIX checks.
-
-Use `--enable-psi-posix=section,another,onemore` to enable specific modules only.
-
-The following modules are included by default:
-
-[stdint](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/stdint.h.html),
-[stddef](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/stddef.h.html),
-[stdlib](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/stdlib.h.html),
-[sys/types](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_types.h.html)
-
-The following modules are available to select:
-
-[errno](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html),
-[fcntl](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/fcntl.h.html),
-[glob](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/glob.h.html),
-[locale](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/locale.h.html),
-[ndbm](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/ndbm.h.html),
-[netdb](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/netdb.h.html),
-[netinet/in](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/netinet_in.h.html),
-[netinet/tcp](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/netinet_tcp.h.html),
-[poll](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/poll.h.html),
-[signal](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/signal.h.html),
-[stdio](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/stdio.h.html),
-[sys/select](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_select.h.html),
-[sys/socket](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_socket.h.html),
-[sys/stat](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_stat.h.html),
-[sys/time](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_time.h.html),
-[sys/times](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_times.h.html),
-[sys/uio](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_uio.h.html),
-[sys/utsname](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_utsname.h.html),
-[syslog](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/syslog.h.html),
-[time](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/time.h.html),
-[unistd](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/unistd.h.html),
-[wchar](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/wchar.h.html),
-[wctype](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/wctype.h.html),
-
### --with-psi-libjit
**Path to libjit.**
A colon separated list of directories to scan for `*.psi` files. Defaults to "psi.d".
+### psi.blacklist.decls
+
+A comma separated list of C function declarations to ignore.
+
+### psi.blacklist.vars
+
+A comma separated list of C variable declarations to ignore.
+
## PSI files
+### CPP
+
+* conditional parsing
+* including headers
+
+```c
+#include <string.h>
+```
+
### Comments
* C style multi line comments
* C++ style single line comments
-* CPP directives are ignored, so the hash sign basically works as single line comment
```c
// this is a one line comment
by a multi
line comment
*/
-# this looks like a pre-processor directive and is ignored
```
### Typedefs
```
These statements define what library should be `dlopen()`-ed to look up symbols from declarations.
-They must only occur once in a file. When a `lib` statement is omitted, stdlib is assumed.
+When a `lib` statement is omitted, stdlib is assumed.
### Declarations
## Complete example
```c
-# all declarations in this file should be looked up in libidn
+// all declarations in this file should be looked up in libidn
lib "idn";
-# IDNA errors
+// IDNA errors
const int \IDNA_SUCCESS = 0;
const int \IDNA_STRINGPREP_ERROR = 1;
const int \IDNA_PUNYCODE_ERROR = 2;
const int \IDNA_ICONV_ERROR = 9;
const int \IDNA_MALLOC_ERROR = 201;
const int \IDNA_DLOPEN_ERROR = 202;
-# IDNA flags
+// IDNA flags
const int \IDNA_ALLOW_UNASSIGNED = 1;
const int \IDNA_USE_STD3_ASCII_RULES = 2;
-# nothing special about the declaration here
+// nothing special about the declaration here
default int idna_to_ascii_8z(char *host, char **buffer, int flags);
function idn\utf8_to_ascii(string $host, string &$result, int $flags = 0) : int {
- # there must be a `let` statement for each
- # declared argument of the called function
+ // there must be a `let` statement for each
+ // declared argument of the called function
- # setup a pointer to NULL
+ // setup a pointer to NULL
let buffer = &NULL;
- # setup a string pointer to $host
+ // setup a string pointer to $host
let host = strval($host);
- # assing the integer value of $flags
+ // assing the integer value of $flags
let flags = intval($flags);
- # the function to call is referenced in
- # the return statement, along with the
- # neccessary cast how to interpred the
- # returned native value
+ // the function to call is referenced in
+ // the return statement, along with the
+ // neccessary cast how to interpred the
+ // returned native value
return to_int(idna_to_ascii_8z);
- # by-ref vars might receive output values
- # through `set` statments, which also
- # require a cast how to marshal the
- # native data as PHP value
+ // by-ref vars might receive output values
+ // through `set` statments, which also
+ // require a cast how to marshal the
+ // native data as PHP value
set $result = to_string(*buffer);
- # after the buffer has been marshaled
- # for the PHP engine, we have to free
- # the buffer to avoid a memory leak
+ // after the buffer has been marshaled
+ // for the PHP engine, we have to free
+ // the buffer to avoid a memory leak
free free(*buffer);
- # note that in this example we omit the
- # declaration of the free() function called
- # in our `free` statement for brevity
+ // note that in this example we omit the
+ // declaration of the free() function called
+ // in our `free` statement for brevity
}
default char *idna_strerror(int rc);
projects / m6w6 / ext-psi / blobdiff