From a1cbc19bbcc9714a5c53fb68bbe61490dbe38ec0 Mon Sep 17 00:00:00 2001
From: Tyson Andre <tandre@themeetgroup.com>
Date: Sat, 15 Feb 2020 18:23:59 -0500
Subject: [PATCH] Fix parsing of static return types

Support https://wiki.php.net/rfc/static_return_type
---
 src/Parser.php                                |   2 +-
 tests/cases/parser/staticReturnType1.php      |   6 +
 tests/cases/parser/staticReturnType1.php.diag |   1 +
 tests/cases/parser/staticReturnType1.php.tree | 122 +++++++++++++++
 tests/cases/parser/staticReturnType2.php      |   6 +
 tests/cases/parser/staticReturnType2.php.diag |  32 ++++
 tests/cases/parser/staticReturnType2.php.tree | 145 ++++++++++++++++++
 7 files changed, 313 insertions(+), 1 deletion(-)
 create mode 100644 tests/cases/parser/staticReturnType1.php
 create mode 100644 tests/cases/parser/staticReturnType1.php.diag
 create mode 100644 tests/cases/parser/staticReturnType1.php.tree
 create mode 100644 tests/cases/parser/staticReturnType2.php
 create mode 100644 tests/cases/parser/staticReturnType2.php.diag
 create mode 100644 tests/cases/parser/staticReturnType2.php.tree

diff --git a/src/Parser.php b/src/Parser.php
index c8984b7b..5d29b7cb 100644
--- a/src/Parser.php
+++ b/src/Parser.php
@@ -132,7 +132,7 @@ public function __construct() {
             [TokenKind::ArrayKeyword, TokenKind::CallableKeyword, TokenKind::BoolReservedWord,
             TokenKind::FloatReservedWord, TokenKind::IntReservedWord, TokenKind::StringReservedWord,
             TokenKind::ObjectReservedWord, TokenKind::NullReservedWord, TokenKind::FalseReservedWord]; // TODO update spec
-        $this->returnTypeDeclarationTokens = \array_merge([TokenKind::VoidReservedWord, TokenKind::NullReservedWord, TokenKind::FalseReservedWord], $this->parameterTypeDeclarationTokens);
+        $this->returnTypeDeclarationTokens = \array_merge([TokenKind::VoidReservedWord, TokenKind::NullReservedWord, TokenKind::FalseReservedWord, TokenKind::StaticKeyword], $this->parameterTypeDeclarationTokens);
     }
 
     /**
diff --git a/tests/cases/parser/staticReturnType1.php b/tests/cases/parser/staticReturnType1.php
new file mode 100644
index 00000000..d6a0ef98
--- /dev/null
+++ b/tests/cases/parser/staticReturnType1.php
@@ -0,0 +1,6 @@
+<?php
+class A {
+    public function f() : static {
+        return $this;
+    }
+}
diff --git a/tests/cases/parser/staticReturnType1.php.diag b/tests/cases/parser/staticReturnType1.php.diag
new file mode 100644
index 00000000..0637a088
--- /dev/null
+++ b/tests/cases/parser/staticReturnType1.php.diag
@@ -0,0 +1 @@
+[]
\ No newline at end of file
diff --git a/tests/cases/parser/staticReturnType1.php.tree b/tests/cases/parser/staticReturnType1.php.tree
new file mode 100644
index 00000000..ead87421
--- /dev/null
+++ b/tests/cases/parser/staticReturnType1.php.tree
@@ -0,0 +1,122 @@
+{
+    "SourceFileNode": {
+        "statementList": [
+            {
+                "InlineHtml": {
+                    "scriptSectionEndTag": null,
+                    "text": null,
+                    "scriptSectionStartTag": {
+                        "kind": "ScriptSectionStartTag",
+                        "textLength": 6
+                    }
+                }
+            },
+            {
+                "ClassDeclaration": {
+                    "abstractOrFinalModifier": null,
+                    "classKeyword": {
+                        "kind": "ClassKeyword",
+                        "textLength": 5
+                    },
+                    "name": {
+                        "kind": "Name",
+                        "textLength": 1
+                    },
+                    "classBaseClause": null,
+                    "classInterfaceClause": null,
+                    "classMembers": {
+                        "ClassMembersNode": {
+                            "openBrace": {
+                                "kind": "OpenBraceToken",
+                                "textLength": 1
+                            },
+                            "classMemberDeclarations": [
+                                {
+                                    "MethodDeclaration": {
+                                        "modifiers": [
+                                            {
+                                                "kind": "PublicKeyword",
+                                                "textLength": 6
+                                            }
+                                        ],
+                                        "functionKeyword": {
+                                            "kind": "FunctionKeyword",
+                                            "textLength": 8
+                                        },
+                                        "byRefToken": null,
+                                        "name": {
+                                            "kind": "Name",
+                                            "textLength": 1
+                                        },
+                                        "openParen": {
+                                            "kind": "OpenParenToken",
+                                            "textLength": 1
+                                        },
+                                        "parameters": null,
+                                        "closeParen": {
+                                            "kind": "CloseParenToken",
+                                            "textLength": 1
+                                        },
+                                        "colonToken": {
+                                            "kind": "ColonToken",
+                                            "textLength": 1
+                                        },
+                                        "questionToken": null,
+                                        "returnType": {
+                                            "kind": "StaticKeyword",
+                                            "textLength": 6
+                                        },
+                                        "otherReturnTypes": null,
+                                        "compoundStatementOrSemicolon": {
+                                            "CompoundStatementNode": {
+                                                "openBrace": {
+                                                    "kind": "OpenBraceToken",
+                                                    "textLength": 1
+                                                },
+                                                "statements": [
+                                                    {
+                                                        "ReturnStatement": {
+                                                            "returnKeyword": {
+                                                                "kind": "ReturnKeyword",
+                                                                "textLength": 6
+                                                            },
+                                                            "expression": {
+                                                                "Variable": {
+                                                                    "dollar": null,
+                                                                    "name": {
+                                                                        "kind": "VariableName",
+                                                                        "textLength": 5
+                                                                    }
+                                                                }
+                                                            },
+                                                            "semicolon": {
+                                                                "kind": "SemicolonToken",
+                                                                "textLength": 1
+                                                            }
+                                                        }
+                                                    }
+                                                ],
+                                                "closeBrace": {
+                                                    "kind": "CloseBraceToken",
+                                                    "textLength": 1
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            ],
+                            "closeBrace": {
+                                "kind": "CloseBraceToken",
+                                "textLength": 1
+                            }
+                        }
+                    }
+                }
+            }
+        ],
+        "endOfFileToken": {
+            "kind": "EndOfFileToken",
+            "textLength": 0
+        }
+    }
+}
\ No newline at end of file
diff --git a/tests/cases/parser/staticReturnType2.php b/tests/cases/parser/staticReturnType2.php
new file mode 100644
index 00000000..680b50d8
--- /dev/null
+++ b/tests/cases/parser/staticReturnType2.php
@@ -0,0 +1,6 @@
+<?php
+class X {
+    // Static is forbidden in param types
+    public function test(static $x) {
+    }
+}
diff --git a/tests/cases/parser/staticReturnType2.php.diag b/tests/cases/parser/staticReturnType2.php.diag
new file mode 100644
index 00000000..8a8c1a78
--- /dev/null
+++ b/tests/cases/parser/staticReturnType2.php.diag
@@ -0,0 +1,32 @@
+[
+    {
+        "kind": 0,
+        "message": "')' expected.",
+        "start": 83,
+        "length": 0
+    },
+    {
+        "kind": 0,
+        "message": "'{' expected.",
+        "start": 83,
+        "length": 0
+    },
+    {
+        "kind": 0,
+        "message": "';' expected.",
+        "start": 92,
+        "length": 0
+    },
+    {
+        "kind": 0,
+        "message": "Unexpected ')'",
+        "start": 92,
+        "length": 1
+    },
+    {
+        "kind": 0,
+        "message": "'}' expected.",
+        "start": 103,
+        "length": 0
+    }
+]
\ No newline at end of file
diff --git a/tests/cases/parser/staticReturnType2.php.tree b/tests/cases/parser/staticReturnType2.php.tree
new file mode 100644
index 00000000..971d7267
--- /dev/null
+++ b/tests/cases/parser/staticReturnType2.php.tree
@@ -0,0 +1,145 @@
+{
+    "SourceFileNode": {
+        "statementList": [
+            {
+                "InlineHtml": {
+                    "scriptSectionEndTag": null,
+                    "text": null,
+                    "scriptSectionStartTag": {
+                        "kind": "ScriptSectionStartTag",
+                        "textLength": 6
+                    }
+                }
+            },
+            {
+                "ClassDeclaration": {
+                    "abstractOrFinalModifier": null,
+                    "classKeyword": {
+                        "kind": "ClassKeyword",
+                        "textLength": 5
+                    },
+                    "name": {
+                        "kind": "Name",
+                        "textLength": 1
+                    },
+                    "classBaseClause": null,
+                    "classInterfaceClause": null,
+                    "classMembers": {
+                        "ClassMembersNode": {
+                            "openBrace": {
+                                "kind": "OpenBraceToken",
+                                "textLength": 1
+                            },
+                            "classMemberDeclarations": [
+                                {
+                                    "MethodDeclaration": {
+                                        "modifiers": [
+                                            {
+                                                "kind": "PublicKeyword",
+                                                "textLength": 6
+                                            }
+                                        ],
+                                        "functionKeyword": {
+                                            "kind": "FunctionKeyword",
+                                            "textLength": 8
+                                        },
+                                        "byRefToken": null,
+                                        "name": {
+                                            "kind": "Name",
+                                            "textLength": 4
+                                        },
+                                        "openParen": {
+                                            "kind": "OpenParenToken",
+                                            "textLength": 1
+                                        },
+                                        "parameters": null,
+                                        "closeParen": {
+                                            "error": "MissingToken",
+                                            "kind": "CloseParenToken",
+                                            "textLength": 0
+                                        },
+                                        "colonToken": null,
+                                        "questionToken": null,
+                                        "returnType": null,
+                                        "otherReturnTypes": null,
+                                        "compoundStatementOrSemicolon": {
+                                            "CompoundStatementNode": {
+                                                "openBrace": {
+                                                    "error": "MissingToken",
+                                                    "kind": "OpenBraceToken",
+                                                    "textLength": 0
+                                                },
+                                                "statements": [
+                                                    {
+                                                        "FunctionStaticDeclaration": {
+                                                            "staticKeyword": {
+                                                                "kind": "StaticKeyword",
+                                                                "textLength": 6
+                                                            },
+                                                            "staticVariableNameList": {
+                                                                "StaticVariableNameList": {
+                                                                    "children": [
+                                                                        {
+                                                                            "StaticVariableDeclaration": {
+                                                                                "variableName": {
+                                                                                    "kind": "VariableName",
+                                                                                    "textLength": 2
+                                                                                },
+                                                                                "equalsToken": null,
+                                                                                "assignment": null
+                                                                            }
+                                                                        }
+                                                                    ]
+                                                                }
+                                                            },
+                                                            "semicolon": {
+                                                                "error": "MissingToken",
+                                                                "kind": "SemicolonToken",
+                                                                "textLength": 0
+                                                            }
+                                                        }
+                                                    },
+                                                    {
+                                                        "error": "SkippedToken",
+                                                        "kind": "CloseParenToken",
+                                                        "textLength": 1
+                                                    },
+                                                    {
+                                                        "CompoundStatementNode": {
+                                                            "openBrace": {
+                                                                "kind": "OpenBraceToken",
+                                                                "textLength": 1
+                                                            },
+                                                            "statements": [],
+                                                            "closeBrace": {
+                                                                "kind": "CloseBraceToken",
+                                                                "textLength": 1
+                                                            }
+                                                        }
+                                                    }
+                                                ],
+                                                "closeBrace": {
+                                                    "kind": "CloseBraceToken",
+                                                    "textLength": 1
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            ],
+                            "closeBrace": {
+                                "error": "MissingToken",
+                                "kind": "CloseBraceToken",
+                                "textLength": 0
+                            }
+                        }
+                    }
+                }
+            }
+        ],
+        "endOfFileToken": {
+            "kind": "EndOfFileToken",
+            "textLength": 0
+        }
+    }
+}
\ No newline at end of file