Initial commit

Author: SerafimArts

.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_style = space
+indent_size = 4

.gitattributes

@@ -0,0 +1,13 @@
+* text=auto
+
+/.github export-ignore
+/tests export-ignore
+
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.styleci.yml export-ignore
+.travis.yml export-ignore
+
+monorepo-builder.php export-ignore
+phpunit.xml export-ignore

.gitignore

@@ -0,0 +1,9 @@
+.idea/
+vendor/
+
+# Local testing
+include/
+test.php
+
+composer.lock
+.phpunit.result.cache

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © Kirill Nesmeyanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,29 @@
+# FFI Proxy
+
+A set of classes for creating FFI proxies.
+
+## Requirements
+
+- PHP >= 7.4
+- ext-ffi
+
+## Installation
+
+Library is available as composer repository and can be installed using the 
+following command in a root of your project.
+
+```sh
+$ composer require ffi/proxy
+```
+
+## Usage
+
+```php
+class Example extends FFI\Proxy\Proxy
+{
+    public function __construct()
+    {
+        $this->ffi = \FFI::cdef('...');
+    }
+}
+```

composer.json

@@ -0,0 +1,35 @@
+{
+    "name": "ffi/proxy",
+    "description": "PHP FFI Proxy",
+    "license": "MIT",
+    "keywords": ["ffi", "proxy"],
+    "require": {
+        "php": ">=7.4",
+        "ext-ffi": "*"
+    },
+    "autoload": {
+        "psr-4": {
+            "FFI\\Proxy\\": "src"
+        }
+    },
+    "require-dev": {
+        "vimeo/psalm": "^4.9",
+        "jetbrains/phpstorm-attributes": "^1.0",
+        "phpunit/phpunit": "^9.0"
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "FFI\\Proxy\\Tests\\": "tests"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0.x-dev"
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

phpunit.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         colors="true"
+         backupGlobals="true"
+         stopOnFailure="false"
+         processIsolation="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+>
+    <coverage>
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory suffix="TestCase.php">tests</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <ini name="error_reporting" value="-1"/>
+        <ini name="memory_limit" value="-1"/>
+    </php>
+</phpunit>

psalm.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="1"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/ApiAwareTrait.php

@@ -0,0 +1,61 @@
+<?php
+
+/**
+ * This file is part of FFI package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace FFI\Proxy;
+
+use FFI\CData;
+use FFI\CType;
+use FFI\ParserException;
+
+/**
+ * @property-read \FFI $ffi
+ * @mixin ApiInterface
+ * @psalm-require-implements ApiInterface
+ */
+trait ApiAwareTrait
+{
+    /**
+     * @see ApiInterface::new()
+     * @throws ParserException
+     *
+     * @psalm-param string|CType $type
+     * @psalm-param bool $owned
+     * @psalm-param bool $persistent
+     * @psalm-return CData|null
+     */
+    public function new($type, bool $owned = true, bool $persistent = false): ?CData
+    {
+        return $this->ffi->new($type, $owned, $persistent);
+    }
+
+    /**
+     * @see ApiInterface::cast()
+     *
+     * @psalm-param CType|string $type
+     * @psalm-param CData|int|float|bool|null $ptr
+     * @psalm-return CData|null
+     */
+    public function cast($type, $ptr): ?CData
+    {
+        return $this->ffi->cast($type, $ptr);
+    }
+
+    /**
+     * @see ApiInterface::type()
+     *
+     * @psalm-param string $type
+     * @psalm-return CType|null
+     */
+    public function type(string $type): ?CType
+    {
+        return $this->ffi->type($type);
+    }
+}

src/ApiInterface.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * This file is part of FFI package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace FFI\Proxy;
+
+use FFI\CData;
+use FFI\CType;
+use FFI\ParserException;
+
+interface ApiInterface
+{
+    /**
+     * @see \FFI::new()
+     *
+     * @param string|CType $type
+     * @param bool $owned
+     * @param bool $persistent
+     * @return CData|null
+     * @throws ParserException
+     */
+    public function new($type, bool $owned = true, bool $persistent = false): ?CData;
+
+    /**
+     * @see \FFI::cast()
+     *
+     * @param CType|string $type
+     * @param CData|int|float|bool|null $ptr
+     * @return CData|null
+     */
+    public function cast($type, $ptr): ?CData;
+
+    /**
+     * @see \FFI::type()
+     *
+     * @param string $type
+     * @return CType|null
+     */
+    public function type(string $type): ?CType;
+}

src/Exception/NotAvailableException.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * This file is part of FFI package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace FFI\Proxy\Exception;
+
+class NotAvailableException extends ProxyException
+{
+}

src/Exception/ProxyException.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * This file is part of FFI package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace FFI\Proxy\Exception;
+
+class ProxyException extends \Exception
+{
+}

src/Proxy.php

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * This file is part of FFI package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace FFI\Proxy;
+
+use FFI\Proxy\Exception\NotAvailableException;
+
+abstract class Proxy implements ProxyInterface, ApiInterface
+{
+    use ProxyAwareTrait;
+    use ApiAwareTrait;
+
+    /**
+     * @psalm-allow-private-mutation
+     * @psalm-readonly
+     * @var \FFI
+     */
+    public \FFI $ffi;
+
+    /**
+     * Proxy should not be serializable.
+     */
+    public function __sleep(): array
+    {
+        throw new NotAvailableException('Cannot serialize proxy class');
+    }
+
+    /**
+     * Proxy should not be restorable from strings.
+     */
+    public function __wakeup()
+    {
+        throw new NotAvailableException('Cannot unserialize proxy class');
+    }
+
+    /**
+     * Proxy should not be serializable.
+     */
+    public function __serialize(): array
+    {
+        throw new NotAvailableException('Cannot serialize proxy class');
+    }
+
+    /**
+     * Proxy should not be restorable from strings.
+     */
+    public function __unserialize(array $data): void
+    {
+        throw new NotAvailableException('Cannot unserialize proxy class');
+    }
+
+    /**
+     * Proxy should not be cloneable.
+     */
+    public function __clone()
+    {
+        throw new NotAvailableException('Cannot clone proxy class');
+    }
+}