Merge pull request #15 from pinepain/rename_to_ref

Rename extension to ref

Author: pinepain

.gitignore

@@ -1,5 +1,6 @@
 .deps
 *.lo
+*.loT
 *.la
 .libs
 acinclude.m4

CMakeLists.txt

@@ -0,0 +1,29 @@
+cmake_minimum_required(VERSION 3.1)
+project(php_ref)
+
+# NOTE: This CMake file is just for syntax highlighting in CLion
+
+include_directories(/usr/local/include/php)
+include_directories(/usr/local/include/php/TSRM)
+include_directories(/usr/local/include/php/Zend)
+include_directories(/usr/local/include/php/ext)
+include_directories(/usr/local/include/php/main)
+include_directories(/usr/local/include/php/sapi)
+
+add_definitions(-DCOMPILE_DL_REF)
+
+set(SOURCE_FILES
+    php_ref.h
+    ref.c
+
+    php_ref_notifier_exception.c
+    php_ref_notifier_exception.h
+
+    php_ref_reference.c
+    php_ref_reference.h
+
+    php_ref_functions.c
+    php_ref_functions.h
+)
+
+add_executable(php_ref ${SOURCE_FILES})

CREDITS

@@ -1 +1 @@
-weak
+ref

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2016 Bogdan Padalko <zaq178miami@gmail.com>
+Copyright (c) 2016 Bogdan Padalko <pinepain@gmail.com>
 
 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

README.md

@@ -1,8 +1,8 @@
-# PHP Weak extension
+# PHP Ref extension
 
-[![Build Status](https://travis-ci.org/pinepain/php-weak.svg)](https://travis-ci.org/pinepain/php-weak)
-[![Windows Build status](https://ci.appveyor.com/api/projects/status/7r07eydi6c3lj36a/branch/master?svg=true)](https://ci.appveyor.com/project/pinepain/php-weak)
-[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/pinepain/php-weak/master/LICENSE)
+[![Build Status](https://travis-ci.org/pinepain/php-ref.svg)](https://travis-ci.org/pinepain/php-ref)
+[![Windows Build status](https://ci.appveyor.com/api/projects/status/7r07eydi6c3lj36a/branch/master?svg=true)](https://ci.appveyor.com/project/pinepain/php-ref)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/pinepain/php-ref/master/LICENSE)
 
 This extension adds [Soft Reference](https://en.wikipedia.org/wiki/Weak_reference) and
 [Weak References](https://en.wikipedia.org/wiki/Weak_reference) to PHP 7 and may serve as a ground for other
@@ -14,8 +14,8 @@ data structures that require advanced referencing model.
 ```php
 <?php
 
-use Weak\Reference;
-use Weak\SoftReference;
+use Ref\WeakReference;
+use Ref\SoftReference;
 
 $obj = new class {
     public function __destruct() {
@@ -32,29 +32,32 @@ $obj = null; // outputs "Object will be destroyed", "Destructor called", "Object
 
 ## Docs
 
-This extension adds `Weak` namespace and all entities are created inside it.
+This extension adds `Ref` namespace and all entities are created inside it.
 
 There are no INI setting or constants provided by this extension.
 
-Brief docs about classes and [functions](./stubs/weak/functions.php)
-may be seen in [stub files](./stubs/weak).
+Brief docs about classes and [functions](./stubs/src/functions.php)
+may be seen in [stub files](./stubs/src).
 
 Short list if what provided by this extension is:
 
-  - `abstract class Weak\AbstractReference` *may not be subclassed directly* [doc](./stubs/weak/AbstractReference.php)
-  - `class Weak\SoftReference extends AbstractReference` [doc](./stubs/weak/SoftReference.php)
-  - `class Weak\Reference extends AbstractReference` [doc](./stubs/weak/Reference.php)
-  - `class Weak\NotifierException extend Exception` [doc](./stubs/weak/NotifierException.php)
-  - `function Weak\refcounted()`
-  - `function Weak\refcount()`
-  - `function Weak\softrefcounted()`
-  - `function Weak\softrefcount()`
-  - `function Weak\softrefs()`
-  - `function Weak\weakrefcounted()`
-  - `function Weak\weakrefcount()`
-  - `function Weak\weakrefs()`
-  - `function Weak\object_handle()`
-  - `function Weak\is_obj_destructor_called()`
+Classes:
+  - `abstract class Ref\AbstractReference` *may not be subclassed directly* ([doc](./stubs/src/AbstractReference.php))
+  - `class Ref\SoftReference extends AbstractReference` ([doc](./stubs/srd/SoftReference.php))
+  - `class Ref\WeakReference extends AbstractReference` ([doc](./stubs/src/Reference.php))
+  - `class Ref\NotifierException extend Exception` ([doc](./stubs/src/NotifierException.php))
+
+Functions ([doc](./stubs/src/functions.php)):
+  - `function Ref\refcounted()`
+  - `function Ref\refcount()`
+  - `function Ref\softrefcounted()`
+  - `function Ref\softrefcount()`
+  - `function Ref\softrefs()`
+  - `function Ref\weakrefcounted()`
+  - `function Ref\weakrefcount()`
+  - `function Ref\weakrefs()`
+  - `function Ref\object_handle()`
+  - `function Ref\is_obj_destructor_called()`
 
 ### References
 
@@ -68,13 +71,13 @@ Note: What this extension provides aren't quite actual soft and weak references,
 
 Notifier can be one of `callable`, `array` or `null` types. `null` notifier denotes no notifier set.
 
-Note that notification happens *after* referent object destruction, so at the time of notification `Weak\Referent::get()` 
+Note that notification happens *after* referent object destruction, so at the time of notification `Ref\Referent::get()` 
 will return `null` (unless rare case when object refcount get incremented in destructor, e.g. by storing destructing value
 somewhere else).
 
 If object destructor or one or more notifiers throw exception, all further notifier callbacks will be called as if
-that exception was thrown inside `try-catch` block. In case one or more exceptions were thrown, `Weak\NotifierException`
-will be thrown and all thrown exceptions will be available via `Weak\NotifierException::getExceptions()` method.
+that exception was thrown inside `try-catch` block. In case one or more exceptions were thrown, `Ref\NotifierException`
+will be thrown and all thrown exceptions will be available via `Ref\NotifierException::getExceptions()` method.
 
 
 ### Cloning
@@ -85,7 +88,7 @@ but they will be invoked with different reference objects.
 ```php
 <?php
 
-use Weak\Reference;
+use Ref\WeakReference;
 
 $obj = new stdClass();
 
@@ -100,7 +103,7 @@ To avoid this you may want to change notifier in `__clone()` method:
 ```php
 <?php
 
-class OwnNotifierReference extends Weak\Reference
+class OwnNotifierReference extends Ref\WeakReference
 {
     public function __clone()
     {
@@ -127,11 +130,11 @@ fatal error.
 
 ## Stub files
 
-If you are also using Composer, it is recommended to add the [php-weak-stub](https://github.com/pinepain/php-weak-stubs)
+If you are also using Composer, it is recommended to add the [php-ref-stub](https://github.com/pinepain/php-ref-stubs)
 package as a dev-mode requirement. It provides skeleton definitions and annotations to enable support for auto-completion
 in your IDE and other code-analysis tools.
 
-    composer require --dev pinepain/php-weak-stubs
+    composer require --dev pinepain/php-ref-stubs
 
 
 ## Extra weak data structures support
@@ -148,8 +151,8 @@ to add it to your project.
 
 ### Building from sources
 
-    git clone https://github.com/pinepain/php-weak.git
-    cd php-weak
+    git clone https://github.com/pinepain/php-ref.git
+    cd php-ref
     phpize && ./configure && make
     make test
 
@@ -160,22 +163,22 @@ To install extension globally run
 You will need to copy the extension config to your php dir, here is example for Ubuntu with PHP 7.0 from
 [Ondřej Surý's PPA for PHP](https://launchpad.net/~ondrej/+archive/ubuntu/php):
 
-    # sudo cp provision/php/weak.ini /etc/php/mods-available/
-    # sudo phpenmod -v ALL weak
+    # sudo cp provision/php/ref.ini /etc/php/mods-available/
+    # sudo phpenmod -v ALL ref
     # sudo service php7.0-fpm restart
 
-You may also want to add php-weak extension as a [composer.json dependency](https://getcomposer.org/doc/02-libraries.md#platform-packages):
+You may also want to add php-ref extension as a [composer.json dependency](https://getcomposer.org/doc/02-libraries.md#platform-packages):
 
     "require": {
         ...
-        "ext-weak": "~0.1.0"
+        "ext-ref": "~0.1.0"
         ...
     }
 
 
 ## Internals
 
-`Weak\Reference` class is implemented by storing tracked object handlers and then wrapping it original `dtor_obj` handler 
+`Ref\WeakReference` class is implemented by storing tracked object handlers and then wrapping it original `dtor_obj` handler
 with a custom one, which meta-code is:
 
 ```php
@@ -194,7 +197,7 @@ foreach($soft_references as $soft_ref_object_handle => $soft_reference) {
 }
 
 if ($exceptions) {
-    throw new Weak\NotifierException('One or more exceptions thrown during notifiers calling', $exceptions);
+    throw new Ref\NotifierException('One or more exceptions thrown during notifiers calling', $exceptions);
 }
 
 if (refcount($object) == 1) {
@@ -217,7 +220,7 @@ if (refcount($object) == 1) {
     }
 
     if ($exceptions) {
-        throw new Weak\NotifierException('One or more exceptions thrown during notifiers calling', $exceptions);
+        throw new Ref\NotifierException('One or more exceptions thrown during notifiers calling', $exceptions);
     }
 } else {
     // required while internally PHP GC mark object as it dtor was called before calling dtor
@@ -228,7 +231,7 @@ if (refcount($object) == 1) {
 ## Development and testing
 
 This extension shipped with Vagrant file which provides basic environment for development and testing purposes.
-To start it, just type `vagrant up` and then `vagrant ssh` in php-weak directory.
+To start it, just type `vagrant up` and then `vagrant ssh` in php-ref directory.
 
 Services available out of the box are:
 
@@ -270,4 +273,4 @@ between large variety of PHP versions.
 
 ## License
 
-[php-weak](https://github.com/pinepain/php-weak) PHP extension is licensed under the [MIT license](http://opensource.org/licenses/MIT).
+[php-ref](https://github.com/pinepain/php-ref) PHP extension is licensed under the [MIT license](http://opensource.org/licenses/MIT).

Vagrantfile

@@ -23,12 +23,12 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   config.vm.network  "private_network", ip: "192.168.33.102"
 
   # NOTE: temporary workaround
-  #config.vm.hostname = "php-weak.vagrant"
-  config.vm.provision :shell, inline: "hostnamectl set-hostname php-weak.vagrant"
+  #config.vm.hostname = "php-ref.vagrant"
+  config.vm.provision :shell, inline: "hostnamectl set-hostname php-ref.vagrant"
 
   config.ssh.insert_key = false
 
-  config.vm.synced_folder ".", "/home/vagrant/php-weak"
+  config.vm.synced_folder ".", "/home/vagrant/php-ref"
 
   config.vm.provider "virtualbox" do |vb|
     # Don't boot with headless mode

appveyor.yml

@@ -15,7 +15,7 @@ matrix:
   fast_finish: true
 
 os: Windows Server 2012
-clone_folder: c:\projects\php-sdk\php-weak-ci\vc14\x86\php\ext\weak
+clone_folder: c:\projects\php-sdk\php-ref-ci\vc14\x86\php\ext\ref
 
 init:
   - ps: |
@@ -32,15 +32,15 @@ init:
 
       $env:PHP="$($env:PHP_VERSION.Substring(0, $env:PHP_VERSION.indexOf('.', 2)))"
 
-      $env:ARTIFACT_NAME="php_weak-$($env:PHP)-$($env:TS_OR_NTS)-vc14-$($env:PLATFORM).zip"
+      $env:ARTIFACT_NAME="php_ref-$($env:PHP)-$($env:TS_OR_NTS)-vc14-$($env:PLATFORM).zip"
 
 install:
   - cd %PHP_SDK%
   - curl -fSL -o php-sdk-binary-tools-20110915.zip 'http://windows.php.net/downloads/php-sdk/php-sdk-binary-tools-20110915.zip'
   - 7z.exe x php-sdk-binary-tools-20110915.zip
   - call bin\phpsdk_setvars.bat
-  - call bin\phpsdk_buildtree.bat php-weak-ci
-  - cd php-weak-ci\vc14\x86
+  - call bin\phpsdk_buildtree.bat php-ref-ci
+  - cd php-ref-ci\vc14\x86
   - curl -fSL -o 'php-%PHP_VERSION%.tar.gz' 'http://us1.php.net/distributions/php-%PHP_VERSION%.tar.gz'
   - ren php php-%PHP_VERSION%
   - 7z.exe x php-%PHP_VERSION%.tar.gz -y
@@ -54,19 +54,33 @@ build_script:
   - echo Building PHP [%PHP_VERSION%]
   - '%PHP_SDK%\bin\phpsdk_setvars'
   - buildconf
-  - configure --disable-all --enable-cli --enable-weak=shared %ENABLE_DISABLE_THREAD_SAFETY%
+  - configure --disable-all --enable-cli --enable-ref=shared %ENABLE_DISABLE_THREAD_SAFETY%
   - nmake
 
 after_build:
   - cd %OUTDIR%
   - dir
   - dir ext
-  - dir ext\weak
-  - 7z a %ARTIFACT_NAME% php_weak.dll
+  - dir ext\ref
+  - 7z a %ARTIFACT_NAME% php_ref.dll
   - appveyor PushArtifact %ARTIFACT_NAME%
 
 test_script:
-  - cd c:\projects\php-sdk\php-weak-ci\vc14\x86\php-%PHP_VERSION%
+  - cd c:\projects\php-sdk\php-ref-ci\vc14\x86\php-%PHP_VERSION%
   - set NO_INTERACTION=1
   - set REPORT_EXIT_STATUS=1
-  - "%OUTDIR%\\php.exe run-tests.php -p %OUTDIR%\\php.exe ext/weak/tests/ -d extension=php_weak.dll -d extension_dir=%OUTDIR%\\"
+  - "%OUTDIR%\\php.exe run-tests.php -p %OUTDIR%\\php.exe ext/ref/tests/ -d extension=php_ref.dll -d extension_dir=%OUTDIR%\\"
+
+on_failure:
+  - cd c:\projects\php-sdk\php-ref-ci\vc14\x86\php-%PHP_VERSION%\ext\ref\tests
+  - ps: |
+      $Result = Get-ChildItem .\* -Include *.diff, *.out, *.mem | sort $Name | ForEach-Object {
+        Write-Output "FILE: $_"
+        Get-Content $_
+        Write-Output " "
+      }
+
+      If ($Result.length) {
+        Write-Output $Result
+        exit 1
+      }

config.m4

@@ -1,11 +1,11 @@
 dnl $Id$
-dnl config.m4 for extension weak
+dnl config.m4 for extension ref
 
-PHP_ARG_ENABLE(weak, whether to enable weak support,
+PHP_ARG_ENABLE(ref, whether to enable ref support,
 dnl Make sure that the comment is aligned:
-[  --enable-weak           Enable weak support])
+[  --enable-ref           Enable ref support])
 
-if test "$PHP_WEAK" != "no"; then
+if test "$PHP_REF" != "no"; then
 
     if test -z "$TRAVIS" ; then
         type git &>/dev/null
@@ -14,23 +14,23 @@ if test "$PHP_WEAK" != "no"; then
             git describe --abbrev=0 --tags &>/dev/null
 
             if test $? -eq 0 ; then
-                AC_DEFINE_UNQUOTED([PHP_WEAK_VERSION], ["`git describe --abbrev=0 --tags`-`git rev-parse --abbrev-ref HEAD`-dev"], [git version])
+                AC_DEFINE_UNQUOTED([PHP_REF_VERSION], ["`git describe --abbrev=0 --tags`-`git rev-parse --abbrev-ref HEAD`-dev"], [git version])
             fi
 
             git rev-parse --short HEAD &>/dev/null
 
             if test $? -eq 0 ; then
-                AC_DEFINE_UNQUOTED([PHP_WEAK_REVISION], ["`git rev-parse --short HEAD`"], [git revision])
+                AC_DEFINE_UNQUOTED([PHP_REF_REVISION], ["`git rev-parse --short HEAD`"], [git revision])
             fi
         else
-            AC_MSG_NOTICE([git not installed. Cannot obtain php-weak version tag. Install git.])
+            AC_MSG_NOTICE([git not installed. Cannot obtain php-ref version tag. Install git.])
         fi
     fi
 
-    PHP_NEW_EXTENSION(weak, [           \
-        weak.c                          \
-        php_weak_notifier_exception.c   \
-        php_weak_reference.c            \
-        php_weak_functions.c            \
+    PHP_NEW_EXTENSION(ref, [            \
+        ref.c                           \
+        php_ref_notifier_exception.c    \
+        php_ref_reference.c             \
+        php_ref_functions.c             \
     ], $ext_shared,, -DZEND_ENABLE_STATIC_TSRMLS_CACHE=1)
 fi

config.w32

@@ -1,8 +1,8 @@
 // $Id$
 // vim:ft=javascript
 
-ARG_ENABLE("weak", "enable weak support", "no");
+ARG_ENABLE("ref", "enable ref support", "no");
 
-if (PHP_WEAK != "no") {
-	EXTENSION("weak", "weak.c php_weak_notifier_exception.c php_weak_reference.c php_weak_functions.c", PHP_WEAK_SHARED, "/DZEND_ENABLE_STATIC_TSRMLS_CACHE=1");
+if (PHP_REF != "no") {
+	EXTENSION("ref", "ref.c php_ref_notifier_exception.c php_ref_reference.c php_ref_functions.c", PHP_REF_SHARED, "/DZEND_ENABLE_STATIC_TSRMLS_CACHE=1");
 }