Support php 8.1 never RFC (nikic#199)

https://wiki.php.net/rfc/noreturn_type

Author: TysonAndre

README.md

@@ -275,6 +275,7 @@ ast\flags\TYPE_NULL    // php 8.0 union types
 ast\flags\TYPE_FALSE   // php 8.0 union types
 ast\flags\TYPE_STATIC  // php 8.0 static return type
 ast\flags\TYPE_MIXED   // php 8.0 mixed type
+ast\flags\TYPE_NEVER   // php 8.1 never type
 
 // Used by ast\AST_CAST (exclusive)
 ast\flags\TYPE_NULL

ast.c

@@ -98,6 +98,10 @@
 # define PARAM_MODIFIER_PRIVATE   ZEND_ACC_PRIVATE
 #endif
 
+#if PHP_VERSION_ID < 80100
+# define IS_NEVER 22
+#endif
+
 /* This contains state of the ast Node creator. */
 typedef struct ast_state_info {
 	zend_long version;
@@ -159,6 +163,7 @@ static const char *type_flags[] = {
 	AST_FLAG(TYPE_ITERABLE),
 	AST_FLAG(TYPE_STATIC),
 	AST_FLAG(TYPE_MIXED),
+	AST_FLAG(TYPE_NEVER),
 	NULL
 };
 
@@ -535,6 +540,7 @@ static const builtin_type_info builtin_types[] = {
 	{ZEND_STRL("false"), IS_FALSE},
 	// {ZEND_STRL("static"), IS_STATIC},  /* Impossible to be parsed before php 8 */
 	{ZEND_STRL("mixed"), IS_MIXED},
+	{ZEND_STRL("never"), IS_NEVER},
 	{NULL, 0, IS_UNDEF}
 };
 static inline zend_uchar lookup_builtin_type(const zend_string *name) {
@@ -1427,6 +1433,7 @@ PHP_MINIT_FUNCTION(ast) {
 	ast_register_flag_constant("TYPE_ITERABLE", IS_ITERABLE);
 	ast_register_flag_constant("TYPE_STATIC", IS_STATIC);
 	ast_register_flag_constant("TYPE_MIXED", IS_MIXED);
+	ast_register_flag_constant("TYPE_NEVER", IS_NEVER);
 
 	ast_register_flag_constant("UNARY_BOOL_NOT", ZEND_BOOL_NOT);
 	ast_register_flag_constant("UNARY_BITWISE_NOT", ZEND_BW_NOT);

ast_stub.php

@@ -144,7 +144,7 @@
 const PARAM_VARIADIC = 16;
 const TYPE_NULL = 1;
 const TYPE_FALSE = 2;
-const TYPE_BOOL = 17;
+const TYPE_BOOL = 18;
 const TYPE_LONG = 4;
 const TYPE_DOUBLE = 5;
 const TYPE_STRING = 6;
@@ -155,6 +155,7 @@
 const TYPE_ITERABLE = 13;
 const TYPE_STATIC = 15;
 const TYPE_MIXED = 16;
+const TYPE_NEVER = 17;
 const UNARY_BOOL_NOT = 14;
 const UNARY_BITWISE_NOT = 13;
 const UNARY_SILENCE = 260;

package.xml

@@ -30,6 +30,7 @@
  <license uri="https://github.com/nikic/php-ast/blob/master/LICENSE">BSD-3-Clause</license>
  <notes>
 - Support php 8.1 enums, add 'type' (for enum type) to AST_CLASS nodes in AST version 85+.
+- Support php 8.1 'never' return type.
  </notes>
  <contents>
   <dir name="/">

tests/metadata.phpt

@@ -56,11 +56,11 @@ AST_METHOD: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE,
 AST_ARROW_FUNC: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL, FUNC_RETURNS_REF, FUNC_GENERATOR]
 AST_CLASS: (combinable) [CLASS_ABSTRACT, CLASS_FINAL, CLASS_TRAIT, CLASS_INTERFACE, CLASS_ANONYMOUS, CLASS_ENUM]
 AST_MAGIC_CONST: [MAGIC_LINE, MAGIC_FILE, MAGIC_DIR, MAGIC_NAMESPACE, MAGIC_FUNCTION, MAGIC_METHOD, MAGIC_CLASS, MAGIC_TRAIT]
-AST_TYPE: [TYPE_NULL, TYPE_FALSE, TYPE_BOOL, TYPE_LONG, TYPE_DOUBLE, TYPE_STRING, TYPE_ARRAY, TYPE_OBJECT, TYPE_CALLABLE, TYPE_VOID, TYPE_ITERABLE, TYPE_STATIC, TYPE_MIXED]
+AST_TYPE: [TYPE_NULL, TYPE_FALSE, TYPE_BOOL, TYPE_LONG, TYPE_DOUBLE, TYPE_STRING, TYPE_ARRAY, TYPE_OBJECT, TYPE_CALLABLE, TYPE_VOID, TYPE_ITERABLE, TYPE_STATIC, TYPE_MIXED, TYPE_NEVER]
 AST_VAR: []
 AST_CONST: []
 AST_UNPACK: []
-AST_CAST: [TYPE_NULL, TYPE_FALSE, TYPE_BOOL, TYPE_LONG, TYPE_DOUBLE, TYPE_STRING, TYPE_ARRAY, TYPE_OBJECT, TYPE_CALLABLE, TYPE_VOID, TYPE_ITERABLE, TYPE_STATIC, TYPE_MIXED]
+AST_CAST: [TYPE_NULL, TYPE_FALSE, TYPE_BOOL, TYPE_LONG, TYPE_DOUBLE, TYPE_STRING, TYPE_ARRAY, TYPE_OBJECT, TYPE_CALLABLE, TYPE_VOID, TYPE_ITERABLE, TYPE_STATIC, TYPE_MIXED, TYPE_NEVER]
 AST_EMPTY: []
 AST_ISSET: []
 AST_SHELL_EXEC: []

tests/never_return_type.phpt

@@ -0,0 +1,27 @@
+--TEST--
+'never' return type parsing
+--FILE--
+<?php
+
+require __DIR__ . '/../util.php';
+
+$code = <<<'PHP'
+<?php
+function up(): never {
+}
+PHP;
+
+$node = ast\parse_code($code, $version=85);
+echo ast_dump($node), "\n";
+--EXPECTF--
+AST_STMT_LIST
+    0: AST_FUNC_DECL
+        flags: 0
+        name: "up"
+        docComment: null
+        params: AST_PARAM_LIST
+        stmts: AST_STMT_LIST
+        returnType: AST_TYPE
+            flags: TYPE_NEVER (%d)
+        attributes: null
+        __declId: 0