Add flag to enable AST functionality, off by default

Closes #75

Author: jbboehr

.ci/travis_php.sh

@@ -2,7 +2,9 @@
 
 export LIBHANDLEBARS_VERSION=${LIBHANDLEBARS_VERSION:-master}
 #export PHP_PSR_VERSION=${PHP_PSR_VERSION:-master}
+export AST=${AST:-false}
 export COVERAGE=${COVERAGE:-true}
+export HARDENING=${HARDENING:-true}
 
 export NO_INTERACTION=1
 export REPORT_EXIT_STATUS=1
@@ -62,6 +64,12 @@ function install_php_handlebars() (
 
     local extra_configure_flags=""
 
+    if [[ "${AST}" != "false" ]]; then
+        extra_configure_flags="${extra_configure_flags} --enable-handlebars-ast"
+    else
+        extra_configure_flags="${extra_configure_flags} --disable-handlebars-ast"
+    fi
+
     if [[ "${HARDENING}" != "false" ]]; then
         extra_configure_flags="${extra_configure_flags} --enable-handlebars-hardening"
     else
@@ -112,6 +120,8 @@ function before_script() (
 function run_examples() (
     set -e -o pipefail
 
+    echo "Running examples"
+
     for i in `find examples -name "*.php" -not -name benchmarks.php`; do
         printf "\nExecuting example ${i}:\n"
         php -d extension=modules/handlebars.so $i
@@ -120,6 +130,17 @@ function run_examples() (
     return 0
 )
 
+function run_stubs() {
+    set -e -o pipefail
+
+    echo "Running stubs"
+
+    php handlebars.stub.php
+    php handlebars-ast.stub.php
+
+    return 0
+}
+
 function script() (
     set -e -o pipefail
 
@@ -133,7 +154,6 @@ function script() (
         ${extra_flags} \
         -d extension=modules/handlebars.so
 
-    echo "Running examples"
     run_examples
 
     echo "Running benchmarks"

.travis.yml

@@ -9,26 +9,43 @@ matrix:
   fast_finish: true
   allow_failures:
   - php: 'master'
-  - php: 'master'
-    env:
-    - PHP_PSR_VERSION=v1.0.0
   - language: nix
     env:
-      - NIX_CHANNEL=unstable
-      - NIX_PHP_ATTR=php
+    - NIX_CHANNEL=unstable
+    - NIX_PHP_ATTR=php
   include:
+# basic
   - language: php
     php: '7.2'
   - language: php
     php: '7.3'
   - language: php
     php: '7.4'
+  - language: php
+    php: 'master'
+# ast
+  - language: php
+    php: '7.2'
+    env:
+    - AST=true
+  - language: php
+    php: '7.3'
+    env:
+    - AST=true
   - language: php
     php: '7.4'
     env:
-    - HARDENING=false
+    - AST=true
   - language: php
     php: 'master'
+    env:
+    - AST=true
+# no hardening
+  - language: php
+    php: '7.4'
+    env:
+    - HARDENING=false
+# psr
   - language: php
     php: '7.2'
     env:
@@ -45,8 +62,10 @@ matrix:
     php: 'master'
     env:
     - PHP_PSR_VERSION=v1.0.0
+# fedora
   - env:
     - DOCKER_IMAGE=fedora31
+# nix
   - language: nix
     env:
     - NIX_CHANNEL=20.03

ci.nix

@@ -30,19 +30,31 @@ let
 
     generateHandlebarsTestsForPlatform = { pkgs, path, phpAttr, phpHandlebarsSrc }:
         pkgs.recurseIntoAttrs {
-            handlebars = let
+            # std
+            std = let
                 php = pkgs.${phpAttr};
             in pkgs.callPackage ./default.nix {
                 inherit phpHandlebarsSrc;
                 php = pkgs.${phpAttr};
                 buildPecl = pkgs.callPackage "${path}/pkgs/build-support/build-pecl.nix" { inherit php; };
+                astSupport = false;
             };
-            # cross-compile for 32bit
-            handlebars32bit = let
+            # i686
+            i686 = let
                 php = pkgs.pkgsi686Linux.${phpAttr};
             in pkgs.pkgsi686Linux.callPackage ./default.nix {
                 inherit phpHandlebarsSrc;
                 buildPecl = pkgs.pkgsi686Linux.callPackage "${path}/pkgs/build-support/build-pecl.nix" { inherit php; };
+                astSupport = true;
+            };
+            # ast
+            ast = let
+                php = pkgs.${phpAttr};
+            in pkgs.callPackage ./default.nix {
+                inherit phpHandlebarsSrc;
+                php = pkgs.${phpAttr};
+                buildPecl = pkgs.callPackage "${path}/pkgs/build-support/build-pecl.nix" { inherit php; };
+                astSupport = true;
             };
         };
 in

config.m4

@@ -19,6 +19,9 @@ m4_define(AM_LDFLAGS, [LDFLAGS])
 PHP_ARG_ENABLE(handlebars, whether to enable handlebars support,
 [  --enable-handlebars     Enable handlebars support])
 
+PHP_ARG_ENABLE(handlebars-ast, whether to enable handlebars AST support,
+[  --enable-handlebars-ast Enable handlebars AST support], [no], [no])
+
 PHP_ARG_ENABLE(handlebars-psr, whether to enable handlebars PSR support,
 [  --enable-handlebars-psr Enable handlebars PSR support], [no], [no])
 
@@ -113,20 +116,26 @@ if test "$PHP_HANDLEBARS" != "no"; then
     PHP_HANDLEBARS_ADD_SOURCES([
         src/php_handlebars.c
         src/impl.c
-        src/compiler.c
         src/exceptions.c
-        src/opcode.c
         src/options.c
-        src/parser.c
-        src/program.c
         src/registry.c
         src/safe_string.c
-        src/token.c
-        src/tokenizer.c
         src/utils.c
         src/vm.c
         src/value.c
     ])
+    if test "$PHP_HANDLEBARS_AST" == "yes"; then
+        AC_DEFINE([PHP_HANDLEBARS_ENABLE_AST], [1], [Whether to enable AST support])
+        PHP_HANDLEBARS_ADD_SOURCES([
+            src/compiler.c
+            src/opcode.c
+            src/parser.c
+            src/program.c
+            src/token.c
+            src/tokenizer.c
+        ])
+    fi
+
     PHP_ADD_BUILD_DIR(src)
     PHP_ADD_INCLUDE([vendor])
     PHP_INSTALL_HEADERS([ext/handlebars], [php_handlebars.h])

default.nix

@@ -22,6 +22,7 @@
   phpHandlebarsSha256 ? null,
   phpHandlebarsAllTheTests ? false,
 
+  astSupport ? false,
   hardeningSupport ? true,
 
   mustache_spec ? pkgs.callPackage (import ((fetchTarball {
@@ -47,6 +48,6 @@
 
 pkgs.callPackage ./derivation.nix {
   inherit buildPecl mustache_spec handlebars_spec handlebarsc php_psr phpHandlebarsVersion phpHandlebarsSrc phpHandlebarsSha256 phpHandlebarsAllTheTests;
-  inherit hardeningSupport;
+  inherit astSupport hardeningSupport;
 }
 

derivation.nix

@@ -8,6 +8,7 @@
   phpHandlebarsSha256 ? null,
   phpHandlebarsAllTheTests ? false,
 
+  astSupport ? false,
   hardeningSupport ? true
 }:
 
@@ -28,6 +29,8 @@ buildPecl rec {
   nativeBuildInputs = [ mustache_spec handlebars_spec ];
 
   configureFlags = []
+    ++ lib.optional  astSupport "--enable-handlebars-ast"
+    ++ lib.optional  (!astSupport) "--disable-handlebars-ast"
     ++ lib.optional  hardeningSupport "--enable-handlebars-hardening"
     ++ lib.optional  (!hardeningSupport) "--disable-handlebars-hardening"
     ;

generate-tests.php

@@ -11,6 +11,7 @@
 }
 if( !extension_loaded('handlebars') ) {
     require 'handlebars.stub.php';
+    require 'handlebars-ast.stub.php';
 }
 
 $startTime = microtime(true);
@@ -234,6 +235,13 @@ function hbs_generate_test_head(array &$test) {
     if (!empty($test['number'])) {
         $testName .= ' - ' . $test['number'];
     }
+    $extraSkip = '';
+
+    if( $test['suiteType'] == 'export' || $test['suiteName'] == 'parser' || $test['suiteName'] == 'tokenizer' ) {
+        $extraSkip .= <<<EOF
+if( !class_exists('Handlebars\\Compiler') ) die('skip handlebars AST not enabled');
+EOF;
+    }
 
     switch( $test['description'] . ' - ' . $test['it'] ) {
     	case 'Standalone Indentation - Each line of the partial should be indented before rendering.':
@@ -316,10 +324,8 @@ function hbs_generate_test_head(array &$test) {
         }
     }
 
-    $extraSkip = null;
     if ($test['suiteType'] === 'mustache' && $test['suiteName'] === 'lambdas') {
-        $extraSkip = <<<EOF
-
+        $extraSkip .= <<<EOF
 if( !defined('Handlebars\\Compiler::MUSTACHE_STYLE_LAMBDAS') ) die('skip configured libhandlebars version has no lambda support');
 EOF;
     }