rfc:chaining_comparison

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
rfc:chaining_comparison [2016/12/22 00:24] bp1222rfc:chaining_comparison [2021/03/27 14:58] (current) – Move to inactive ilutov
Line 4: Line 4:
   * Author: David Walker (dave@mudsite.com)   * Author: David Walker (dave@mudsite.com)
   * Author: Richard Fussenegger (php@fleshgrinder.com)   * Author: Richard Fussenegger (php@fleshgrinder.com)
-  * Status: Draft+  * Status: Inactive
   * First Published at: http://wiki.php.net/rfc/chaining_comparison   * First Published at: http://wiki.php.net/rfc/chaining_comparison
  
 ===== Introduction ===== ===== Introduction =====
-This RFC proposes a syntax change to allow the chaining together of comparison and equality operations ''[==, !=, !==, ===, <, <=, >, >=]'' to allow arbitrary comparisons.  The initial request that spawned this RFC[1] was initially only for interval checking.  Discussion on the thread expanded the scope of the request to go from strictly interval checking to allowing more arbitrary number of comparisons.  It evolved from there to expand to a majority of the comparison operations.+This RFC proposes a syntax change to allow arbitrary chaining together of comparison and equality operations ''[==, !=, !==, ===, <, <=, >, >=]'' The initial request that spawned this RFC[1] was initially only for interval checking.  Discussion on the thread expanded the scope of the request to go from strictly interval checking to allowing more arbitrary number of comparisons.  It evolved from there to expand to a majority of the comparison operations.  The primary benefit to this proposal would be to make for more readable code when doing numerous comparisons between a single variable.
  
 <file php> <file php>
Line 22: Line 22:
  
 /* /*
- * To allow this to be functionally the same+ * To be functionally equivalent to this syntax
  */  */
 if (0 < $a < 100) { if (0 < $a < 100) {
Line 31: Line 31:
 ===== Proposal ===== ===== Proposal =====
 Proposals herein will contain a dump of relevant AST (php-ast) nodes and OPCodes (vld) to better visualize the compilation, and execution. Proposals herein will contain a dump of relevant AST (php-ast) nodes and OPCodes (vld) to better visualize the compilation, and execution.
 +
 ==== Comparison Chaining ==== ==== Comparison Chaining ====
-The proposal creates a new AST operation type ''ZEND_AST_COMPARE_OP'' which will be compiled in a left-recursive required manor.  In doing this compilation we ensure short cutting of righter operations if the left sides have evaluated to false.  To accomplish this we introduce a new means of emitting an operation, by noting where a ''JMPZ_EX'' may need to exist (see implementations for ''zend_emit_op_at'').  This will shift operations that may have been emitted by compiling the right side of this AST compare to allow jumping over them if the left side of the operation is evaluated to false.  I believe this means is necessary because we can't just shortcut if the left operation is false, ''false < $a++'' should still evaluate the right part of the expression.  We should only inject the JMPZ_EX ops, IF, the left child is a chained ''ZEND_AST_COMPARE_OP'' The proposal also changes the associativity of the equality, and comparison, operations to being left associative.+The proposal creates a new AST operation type ''ZEND_AST_COMPARE_OP'' which will be compiled in a left-recursive manor.  
  
 <file php> <file php>
Line 117: Line 118:
  */  */
 </file> </file>
 +
 +==== False Short Circuiting ====
 +In doing this compilation we can ensure short cutting of righter operations if the left sides have evaluated to false.  To accomplish this we introduce a new means of emitting an operation, by noting where a ''JMPZ_EX'' may need to exist (see implementations for ''zend_emit_op_at'').  This will shift operations that may have been emitted by compiling the right side of this AST compare to allow jumping over them if the left side of the operation is evaluated to false.  I believe this means is necessary because we can't just shortcut if the left operation is false, ''false < $a++'' should still evaluate the right part of the expression.  We should only inject the JMPZ_EX ops, IF, the left child is a chained ''ZEND_AST_COMPARE_OP'' The proposal also changes the associativity of the equality, and comparison, operations to being left associative.
  
 ===== Backward Incompatible Changes ===== ===== Backward Incompatible Changes =====
Line 126: Line 130:
 ===== RFC Impact ===== ===== RFC Impact =====
 ==== To Opcache ==== ==== To Opcache ====
-Yes, we're adding new JMPZ_EX codes when chaining to ensure false values correctly jump over any pre/post inc/dev ops from eval.+I'm unsure; we're adding new op-codes and/or order of opcodes, but are not introducing any new codes
  
 ===== Open Issues ===== ===== Open Issues =====
Line 161: Line 165:
  
 ==== Right Recursion ==== ==== Right Recursion ====
-Another syntax difference that could be BC problematic is with right-recursion of the chained expression.  Currently PHP will evaluate right recursive single expression comparisons.  The proposed feature would raise a compile time error doing this.  The example being:+Another syntax difference that could be BC problematic is with right-recursion of the chained expression.  Currently PHP will evaluate right recursive single expression comparisons.  The proposed feature would raise a compile time error doing this.  The question is should it, or should we permit right-recursive chaining? The test case we can look at:
  
 <file php> <file php>
 <?php <?php
 +var_dump(1 < (2 < 3));
 +var_dump(1 < 2 == 3);
 +var_dump(1 < 2 == 3 == 4);
 +var_dump(1 < 2 == (3 == 4));
 +</file>
  
 +We will go over how PHP 7.1 currently would evaluate each, and then how a right-recursive chain would pan out.
 +<file php>
 +<?php
 +var_dump(1 < (2 < 3));
 /* /*
- PHP <= 7.1+ (2 < 3) := 1 < true := false
  */  */
-var_dump(1 < (2 < 3); // bool(false) - in short it simplifies:  1 < (true) := false 
-var_dump(1 < 2 == 3); // bool(true) 
-var_dump(1 < 2 == 3 == 4); // Parse Error 
-var_dump(1 < 2 == (3 == 4)); //bool(false) 
  
 +var_dump(1 < 2 == 3);
 /* /*
- Proposed Chaining+ (1 < 2) == 3 := true == 3 := true
  */  */
-var_dump(1 < (2 <3)); // Compile Error 
-var_dump(1 < 2 == 3 == 4); // bool(true) - evaluated: true == 3 == 4 := true == 4 := true 
-var_dump(1 < 2 == (3 == 4)); //bool(false) - evaluated true == false := false 
  
 +var_dump(1 < 2 == 3 == 4);
 /* /*
- Possible change allowing right-recursive chaining+ Parse Error, unexpected ==
  */  */
-var_dump(1 < (2 < 3)); // bool(true) - evaluated as: 1 && (2 < 3) && (1 < 2) := true && true && true := true 
  
 +var_dump(1 < 2 == (3 == 4));
 +/*
 + * (1 < 2) == (3 == 4) := true == false := false
 + */
 </file> </file>
  
-The potential fix, is evaluated as such.  If it looks odd with the ''1 && ...'' that's because we evaluate left to right, and the left side there could have been ''$a++'', we want to ensure the post-inc operator is correctly run as we do evaluate left-to-right.+The current proposal (implemented) evaluation method.  You'll notice that we do permit right-recursion for equality operations.  This is due to the fact that equality operations will evaluate against booleanor boolean-converted values.  Since you don't really care what the left-node of the right-recursive side is, you only care if the right side evaluates to true or not. 
 +<file php> 
 +<?php 
 +var_dump(1 < (2 < 3)); 
 +/* 
 + * Parse Error: No right recursion 
 + */ 
 + 
 +var_dump(1 < 2 == 3); 
 +/* 
 + * (1 < 2) == 3 := true == 3 := true 
 + */ 
 + 
 +var_dump(1 < 2 == 3 == 4); 
 +/* 
 + * ((1 < 2) == 3) == 4 := (true == 3) == 4 := true == 4 := true 
 + */ 
 + 
 +var_dump(1 < 2 == (3 == 4)); 
 +/* 
 + * (1 < 2) == (3 == 4) := true == false := false 
 + */ 
 +</file> 
 + 
 +If however we permitted right recursive comparison operations we would evaluate as such
 +<file php> 
 +<?php 
 +var_dump(1 < (2 < 3)); 
 +/* 
 + * 1 < (2 < 3) := 1 && (2 < 3) && (1 < 2) := true && true && true := true 
 + */ 
 + 
 +var_dump(1 < 2 == 3); 
 +/* 
 + * (1 < 2) == 3 := true == 3 := true 
 + */ 
 + 
 +var_dump(1 < 2 == 3 == 4); 
 +/* 
 + * ((1 < 2) == 3) == 4 := (true == 3) == 4 := true == 4 := true 
 + */ 
 + 
 +var_dump(1 < 2 == (3 == 4)); 
 +/* 
 + * (1 < 2) == (3 == 4) := true == false := false 
 + */ 
 +</file> 
 + 
 +If the first example in this last one looks a little odd, it's because it is We do design for short-cutting of a long expression when a fault is found to prevent further execution much like you have in ''if()'' statements.  However, we do process in a left-to-right manor.  So the first thing would require us to ensure the left most side evaluates to true, and if it wasn't ''1'' but rather ''$a++'', we'want to ensure to get that left nodes potential opcodes to execute before comparing the right hand side.  Since we are chaining, we'd want to evaluate the right, then return the left node of it to be evaluated against the top's left node.  This, odd syntax is why I didn't implement a right-recursive chaining of comparison operations. 
 + 
 +Although allow right-recursion of equality operations does itself introduce some slightly odd syntax like: 
 +<file php> 
 +<?php 
 +/* 
 + * Right chained comparison syntax 
 + */ 
 +var_dump(1 < (2 == 2)); // bool(false) 
 + 
 +/* 
 + * Is Functionally identical to PHP 7.1's allowed syntax 
 + */ 
 +var_dump(1 < (2 <= 2)); // bool(false) 
 +</file> 
 +Since we don't chain together the right/left node of an equality operator, this is functionally identical to PHP 7.1's allowed syntax.  We could, for equality operations denote if they were in-fact a right node-continuation of a chain, thus would allow them to evaluate to either the left node, or false. 
 + 
 + 
 +As we can see right-recursive comparison operations do have numerous caveats and oddities.  For these reasons we didn't implement it, and generally are on the side of forbidding right-recursive comparison operations.
  
 ===== Unaffected PHP Functionality ===== ===== Unaffected PHP Functionality =====
Line 197: Line 274:
  
 ===== Patches and Tests ===== ===== Patches and Tests =====
-Implementation #1: comparisons evaluated before equality: https://github.com/php/php-src/compare/master...bp1222:multi-compare +Working Implementation: comparisons evaluated before equality: https://github.com/php/php-src/compare/master...bp1222:multi-compare
- +
-Implementation #2: comparisons and equality evaluated together: https://github.com/php/php-src/compare/master...bp1222:multi-compare-equal-prec+
  
 Will need eyes of those more familiar with AST/VM to review. Will need eyes of those more familiar with AST/VM to review.
- 
-For changes affecting the core language, you should also provide a patch for the language specification. 
  
 ===== Implementation ===== ===== Implementation =====
rfc/chaining_comparison.1482366256.txt.gz · Last modified: 2017/09/22 13:28 (external edit)