Update built-ins against multiple PHP versions, incl. PHP 7.3.

This commit also reworks the Dockerfile to pull multiple versions of PHP
and rebuild the syntax against each one.

Author: StanAngeloff

Dockerfile

@@ -105,15 +105,17 @@ Developing
 
 When you install `php.vim` using your preferred installation method, all the needed files are already in place.
 
-If you have a more recent version of PHP installed locally (with all of the PHP extensions you want/need), you may use the provided `Dockerfile` to rebuild the syntax file:
+If you wish to rebuild the syntax file with a more recent version of PHP available on the [Docker Hub], you should use the provided `Dockerfile` to do so:
 
 ```bash
-docker build -t stanangeloff/php.vim --no-cache --force-rm .
-docker run --rm -i -v "$PWD":/var/php -t stanangeloff/php.vim > /tmp/php.vim && cat /tmp/php.vim | sed 's/\x0D$//' > syntax/php.vim
-docker rmi stanangeloff/php.vim
+docker build --no-cache --force-rm -f attic/Dockerfile -t php.vim .
+cat syntax/php.vim | docker run --rm -i php.vim > syntax/php.vim.new
+docker rmi php.vim
+mv syntax/php.vim.new syntax/php.vim
 ```
 
-NOTE: The `sed` command strips out Windows line endings. If the updated syntax file fails to load and is corrupted, try loading `syntax/php.vim` in your favourite editor and ensure line endings are set to Unix.
+NOTE: If the updated syntax file fails to load and is corrupted, try loading `syntax/php.vim` in your favourite editor and ensure line endings are set to Unix `\n`.
+
 
   [php.vim-garvin]:  https://github.com/vim-scripts/php.vim--Garvin
   [php.vim-original]: http://www.vim.org/scripts/script.php?script_id=2874
@@ -123,3 +125,4 @@ NOTE: The `sed` command strips out Windows line endings. If the updated syntax f
   [php.vim-source]: https://github.com/StanAngeloff/php.vim/blob/master/syntax/php.vim#L35
   [Blade]: https://github.com/jwalton512/vim-blade
   [syntax-groups]: https://github.com/StanAngeloff/php.vim/blob/41c36f7f/syntax/php.vim#L804
+  [Docker Hub]: https://docs.docker.com/samples/library/php/

README.md

@@ -0,0 +1,6 @@
+<?php
+
+error_reporting(E_ALL | E_DEPRECATED | E_STRICT);
+ini_set('display_errors', 'On');
+
+date_default_timezone_set('UTC');

attic/0-bootstrap.inc.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Script to update Vim's PHP syntax file.
+ *
+ * @author Stan Angeloff <stanimir@angeloff.name>
+ *
+ * @author Paul Garvin <paul@paulgarvin.net>
+ * @copyright Copyright 2009 Paul Garvin
+ * @license http://www.opensource.org/licenses/mit-license.php MIT License
+ *
+ * Loosely based on Paul Garvin <paul@paulgarvin.net> original script.
+ *
+ * For the full copyright and license information,
+ * please view the LICENSE file that was distributed with this source code.
+ */
+
+require __DIR__ . '/0-bootstrap.inc.php';
+
+# Parse the configuration file associated with this script.
+$configuration = parse_ini_file(__DIR__ . '/syntax.ini', /* $process_sections = */ true);
+
+# Process extensions and serialize built-in functions, constants, classes and interfaces.
+$extensions = array();
+
+foreach ($configuration['extensions'] as $extensionName => $isEnabled) {
+    if (! $isEnabled) {
+        continue;
+    }
+
+    try {
+        $reflect = new \ReflectionExtension($extensionName);
+
+        $collected = array(
+            'name' => $reflect->getName(),
+            'versions' => array(sprintf('%d.%d.%d', PHP_MAJOR_VERSION, PHP_MINOR_VERSION, PHP_RELEASE_VERSION)),
+            'classes' => array(),
+            'functions' => array_keys($reflect->getFunctions()),
+            'constants' => array_diff(array_keys($reflect->getConstants()), array('TRUE', 'FALSE', 'NULL')),
+        );
+
+        foreach ($reflect->getClasses() as $extensionClass) {
+            $collected['classes'][] = $extensionClass->getName();
+            $collected['constants'] = array_unique(array_merge($collected['constants'], array_keys($extensionClass->getConstants())));
+        }
+
+        $extensions[$extensionName] = $collected;
+    } catch (ReflectionException $e) {
+        file_put_contents('php://stderr', sprintf('[ERROR] [PHP %d.%d] %\'.12s: %s.' . PHP_EOL, PHP_MAJOR_VERSION, PHP_MINOR_VERSION, $extensionName, rtrim($e->getMessage(), ' ?!.')));
+    }
+}
+
+echo serialize($extensions) . PHP_EOL;

attic/10-collect.php

@@ -0,0 +1,103 @@
+<?php
+
+require __DIR__ . '/0-bootstrap.inc.php';
+
+$extensions = [];
+$versions = [];
+
+while (false !== $line = fgets(STDIN)) {
+    $unserialized = unserialize($line, ['allowed_classes' => false]);
+    foreach ($unserialized as $extension => &$collected) {
+        if (! isset($extensions[$extension])) {
+            $extensions[$extension] = $collected;
+            continue;
+        }
+
+        $extensions[$extension] = array(
+            'name' => $extensions[$extension]['name'],
+            'versions' => array_merge($extensions[$extension]['versions'], $collected['versions']),
+            'classes' => array_merge($extensions[$extension]['classes'], $collected['classes']),
+            'functions' => array_merge($extensions[$extension]['functions'], $collected['functions']),
+            'constants' => array_merge($extensions[$extension]['constants'], $collected['constants']),
+        );
+    }
+}
+
+foreach ($extensions as &$collected) {
+    $collected['classes'] = array_unique($collected['classes']);
+    $collected['functions'] = array_unique($collected['functions']);
+    $collected['constants'] = array_unique($collected['constants']);
+
+    sort($collected['classes'], SORT_NATURAL);
+    sort($collected['functions'], SORT_NATURAL);
+    sort($collected['constants'], SORT_NATURAL);
+
+    $versions = array_merge($versions, $collected['versions']);
+}
+
+$versions = array_unique($versions);
+sort($versions, SORT_NATURAL);
+
+$blocks = array(
+    'extensions' => array(),
+    'last-modified' => sprintf(
+        '%s, PHP %s',
+        date('r' /* RFC 2822 */),
+        implode(/* $glue = */ ', ', $versions)
+    ),
+);
+
+$blocks['extensions'][] = 'if ! exists("g:php_syntax_extensions_enabled")';
+$blocks['extensions'][] = sprintf('    let g:php_syntax_extensions_enabled = ["%s"]', implode(/* $glue = */ '", "', array_map('strtolower', array_keys($extensions))));
+$blocks['extensions'][] = 'endif';
+
+$blocks['extensions'][] = 'if ! exists("g:php_syntax_extensions_disabled")';
+$blocks['extensions'][] = '    let g:php_syntax_extensions_disabled = []';
+$blocks['extensions'][] = 'endif';
+
+$ifExtensionEnabled = function ($extensionName) {
+    return sprintf(
+        'if ' .
+        'index(g:php_syntax_extensions_enabled, "%1$s") >= 0 && ' .
+        'index(g:php_syntax_extensions_disabled, "%1$s") < 0 && ' .
+        '( ! exists("b:php_syntax_extensions_enabled") || index(b:php_syntax_extensions_enabled, "%1$s") >= 0) && ' .
+        '( ! exists("b:php_syntax_extensions_disabled") || index(b:php_syntax_extensions_disabled, "%1$s") < 0)',
+        strtolower($extensionName)
+    );
+};
+
+$blocks['extensions'][] = 'syn case match';
+
+foreach ($extensions as $extension) {
+    if (! count($extension['constants'])) {
+        continue;
+    }
+
+    $blocks['extensions'][] = $ifExtensionEnabled($extension['name']);
+    $blocks['extensions'][] = sprintf('" %s constants', $extension['name']);
+    $blocks['extensions'][] = sprintf('syn keyword phpConstants %s contained', implode(/* $glue = */ ' ', $extension['constants']));
+    $blocks['extensions'][] = 'endif';
+}
+
+$blocks['extensions'][] = 'syn case ignore';
+
+foreach ($extensions as $extension) {
+    if (! count($extension['functions']) && ! count($extension['classes'])) {
+        continue;
+    }
+
+    $blocks['extensions'][] = $ifExtensionEnabled($extension['name']);
+
+    if (count($extension['functions'])) {
+        $blocks['extensions'][] = sprintf('" %s functions', $extension['name']);
+        $blocks['extensions'][] = sprintf('syn keyword phpFunctions %s contained', implode(/* $glue = */ ' ', $extension['functions']));
+    }
+    if (count($extension['classes'])) {
+        $blocks['extensions'][] = sprintf('" %s classes and interfaces', $extension['name']);
+        $blocks['extensions'][] = sprintf('syn keyword phpClasses %s contained', implode(/* $glue = */ ' ', $extension['classes']));
+    }
+
+    $blocks['extensions'][] = 'endif';
+}
+
+echo serialize($blocks);

attic/20-generate.php

@@ -0,0 +1,71 @@
+<?php
+
+require __DIR__ . '/0-bootstrap.inc.php';
+
+$blocks = unserialize(file_get_contents('php://stdin'), ['allowed_classes' => false]);
+
+# Read the existing syntax file with block markers in it.
+#
+$template = file_get_contents($argv[1]);
+
+# Clean up any previously defined blocks.
+$template = preg_replace(
+    sprintf(
+        '/(@block\([\'"](%s)[\'"]\)["\r\n\t ]*).*?(["\r\n\t ]*@endblock)\b/ism',
+        implode(/* $glue = */ '|', array_keys($blocks))
+    ),
+    "\\1___\\2___\\3",
+    $template
+);
+
+# Update block contents in the template.
+foreach ($blocks as $blockName => $lines) {
+    $template = str_ireplace(
+        sprintf('___%s___', $blockName),
+        rtrim(is_array($lines) ? implode(/* $glue = */ "\n", $lines) : $lines),
+        $template
+    );
+}
+
+$template = preg_replace_callback(
+    '/
+        (?<begin>"\s*@copy\s+(?<copy>[a-zA-Z0-9_]+)(?<processors>(\s+(strip_maximum_size))+)?)
+        (?<script>.*?)
+        (?<end>"\s*@end\s+([a-zA-Z0-9_]+))
+    /sx',
+    function (array $groups) use ($template) {
+        $copy = preg_quote($groups['copy'], /* $delimiter = */ '/');
+
+        $processors = array_filter(array_map('trim', preg_split('{[;, ]+}', $groups['processors'])));
+
+        preg_match("/
+            \"\\s*@begin\\s+{$copy}\b
+            (?<script>.*?)
+            \"\\s*@end\\s+{$copy}\b
+        /sx", $template, $captures);
+
+        if (! isset($captures['script'])) {
+            file_put_contents('php://stderr', "[ERROR] The block referenced by '{$groups['begin']}' was not found." . PHP_EOL);
+
+            return $groups['begin'] . $groups['script'] . $groups['end'];
+        }
+
+        $script = $captures['script'];
+
+        foreach ($processors as $processor) {
+            switch ($processor) {
+            case 'strip_maximum_size':
+                $script = preg_replace('{\\\\@\d+}', '\@', $script);
+                break;
+
+            default:
+                file_put_contents('php://stderr', "[ERROR] The processor \"{$processor}\" is not supported, found in '{$groups['begin']}'." . PHP_EOL);
+            }
+        }
+
+        return $groups['begin'] . $script . $groups['end'];
+    },
+    $template
+);
+
+echo $template;