Implement class constant pattern

Author: iluuu1994

Zend/tests/pattern_matching/is/class_constant.phpt

@@ -0,0 +1,44 @@
+--TEST--
+Class constant pattern
+--FILE--
+<?php
+
+class Foo {
+    const A = 'a';
+    private const B = 'b';
+
+    public static function test() {
+        var_dump('b' is self::B);
+        var_dump('c' is self::B);
+    }
+}
+enum Bar {
+    case A;
+}
+
+var_dump('a' is Foo::A);
+var_dump('b' is Foo::A);
+try {
+    var_dump('a' is Foo::B);
+} catch (Error $e) {
+    echo $e->getMessage(), "\n";
+}
+try {
+    var_dump('a' is Foo::C);
+} catch (Error $e) {
+    echo $e->getMessage(), "\n";
+}
+Foo::test();
+var_dump(Bar::A is Bar::A);
+var_dump('foo' is Bar::A);
+
+?>
+--EXPECT--
+bool(true)
+bool(false)
+Cannot access private constant Foo::B
+Undefined constant Foo::C
+bool(true)
+bool(false)
+bool(true)
+bool(false)

Zend/zend_ast.h

@@ -162,6 +162,7 @@ enum _zend_ast_kind {
 	ZEND_AST_RANGE_PATTERN,
 	ZEND_AST_ARRAY_PATTERN_ELEMENT,
 	ZEND_AST_BINDING_PATTERN,
+	ZEND_AST_CLASS_CONST_PATTERN,
 
 	/* 3 child nodes */
 	ZEND_AST_METHOD_CALL = 3 << ZEND_AST_NUM_CHILDREN_SHIFT,

Zend/zend_compile.c

@@ -6086,9 +6086,8 @@ static void zend_compile_match(znode *result, zend_ast *ast)
 	efree(jmp_end_opnums);
 }
 
-static void zend_compile_object_pattern(zend_ast **ast_ptr)
+static void zend_compile_pattern_class_name(zend_ast *ast)
 {
-	zend_ast *ast = *ast_ptr;
 	zend_ast *class_name_ast = ast->child[0];
 	ZEND_ASSERT(class_name_ast->kind == ZEND_AST_ZVAL);
 
@@ -6118,6 +6117,12 @@ static void zend_compile_object_pattern(zend_ast **ast_ptr)
 	}
 }
 
+static void zend_compile_object_pattern(zend_ast **ast_ptr)
+{
+	zend_ast *ast = *ast_ptr;
+	zend_compile_pattern_class_name(ast);
+}
+
 static zend_type zend_compile_single_typename(zend_ast *ast);
 
 static void zend_compile_type_pattern(zend_ast **ast_ptr)
@@ -6144,6 +6149,13 @@ static void zend_compile_type_pattern(zend_ast **ast_ptr)
 	}
 }
 
+static void zend_compile_class_const_pattern(zend_ast **ast_ptr)
+{
+	// zend_ast *ast = *ast_ptr;
+	// FIXME: Compiling the class name breaks zend_get_class_constant_ex.
+	// zend_compile_pattern_class_name(ast);
+}
+
 static void zend_compile_binding_pattern(zend_ast **ast_ptr)
 {
 	zend_ast *binding_pattern_ast = *ast_ptr;
@@ -6204,6 +6216,9 @@ static void zend_compile_pattern(zend_ast **ast_ptr, void *context)
 		case ZEND_AST_ARRAY_PATTERN:
 			zend_compile_array_pattern(ast_ptr);
 			break;
+		case ZEND_AST_CLASS_CONST_PATTERN:
+			zend_compile_class_const_pattern(ast_ptr);
+			break;
 	}
 
 	zend_ast_apply(ast, zend_compile_pattern, context);

Zend/zend_language_parser.y

@@ -284,7 +284,7 @@ static YYSIZE_T zend_yytnamerr(char*, const char*);
 %type <ast> match match_arm_list non_empty_match_arm_list match_arm match_arm_cond_list match_arm_cond
 %type <ast> enum_declaration_statement enum_backing_type enum_case enum_case_expr
 %type <ast> function_name non_empty_member_modifiers
-%type <ast> pattern atomic_pattern compound_pattern type_pattern scalar_pattern or_pattern and_pattern
+%type <ast> pattern atomic_pattern compound_pattern type_pattern scalar_pattern or_pattern and_pattern class_const_pattern
 %type <ast> object_pattern object_pattern_element_list non_empty_object_pattern_element_list
 %type <ast> object_pattern_element range_pattern binding_pattern
 %type <ast> array_pattern array_pattern_element_list array_pattern_element
@@ -1291,6 +1291,7 @@ atomic_pattern:
 	|	range_pattern { $$ = $1; }
 	|	array_pattern { $$ = $1; }
 	|	binding_pattern { $$ = $1; }
+	|	class_const_pattern { $$ = $1; }
 	|	T_UNDERSCORE { $$ = zend_ast_create(ZEND_AST_WILDCARD_PATTERN); }
 	|	'(' pattern ')' { $$ = $2; }
 ;
@@ -1378,6 +1379,11 @@ array_pattern_element:
 			 { $$ = zend_ast_create(ZEND_AST_ARRAY_PATTERN_ELEMENT, $1, $3); }
 ;
 
+class_const_pattern:
+		class_name T_PAAMAYIM_NEKUDOTAYIM identifier
+			{ $$ = zend_ast_create(ZEND_AST_CLASS_CONST_PATTERN, $1, $3); }
+;
+
 inline_function:
 		function returns_ref backup_doc_comment '(' parameter_list ')' lexical_vars return_type
 		backup_fn_flags '{' inner_statement_list '}' backup_fn_flags

Zend/zend_pattern_matching.c

@@ -15,10 +15,12 @@
 */
 
 #include "zend_pattern_matching.h"
+#include "zend_API.h"
 #include "zend_compile.h"
 #include "zend_execute.h"
 #include "zend_exceptions.h"
 #include "zend_type_info.h"
+#include "zend_constants.h"
 
 typedef enum {
 	PM_ERROR = -1,
@@ -228,6 +230,19 @@ static pm_result match_array(zval *zv, zend_ast *pattern)
 	return PM_MATCH;
 }
 
+pm_result match_class_const(zval *zv, zend_ast *pattern)
+{
+	zend_string *class_name = !pattern->attr
+		? zend_ast_get_str(pattern->child[0])
+		: NULL;
+	zend_string *constant_name = zend_ast_get_str(pattern->child[1]);
+	zval *constant_zv = zend_get_class_constant_ex(class_name, constant_name, zend_get_executed_scope(), pattern->attr);
+	if (EG(exception)) {
+		return PM_ERROR;
+	}
+	return zend_is_identical(zv, constant_zv) ? PM_MATCH : PM_MISMATCH;
+}
+
 pm_result zend_pattern_match_ex(zval *zv, zend_ast *pattern)
 {
 	ZVAL_DEREF(zv);
@@ -262,6 +277,8 @@ pm_result zend_pattern_match_ex(zval *zv, zend_ast *pattern)
 			return match_binding(zv, pattern);
 		case ZEND_AST_ARRAY_PATTERN:
 			return match_array(zv, pattern);
+		case ZEND_AST_CLASS_CONST_PATTERN:
+			return match_class_const(zv, pattern);
 		EMPTY_SWITCH_DEFAULT_CASE();
 	}
 }