maride/php-parser
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
z7zmey 2019-02-25 17:01:06 +02:00
parent a7229f53dd
commit c456fa90ce
1 changed files with 6 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
README.md
View File

@ -1,10 +1,3 @@
<!--
Title: PHP Parser
Description: A Parser for PHP written in Go.
Author: Slizov Vadym
Keywords: php parser go golang ast
-->
PHP Parser written in Go PHP Parser written in Go
======================== ========================
@ -26,13 +19,13 @@ Features:
- Fully support PHP 5 and PHP 7 syntax - Fully support PHP 5 and PHP 7 syntax
- Abstract syntax tree (AST) representation - Abstract syntax tree (AST) representation
- Traversing AST - Traversing AST
- Namespace resolver - Resolving namespaced names
- Able to parse syntax-invalid PHP files - Parsing syntax-invalid PHP files
- Saving and printing free-floating comments and whitespaces
Roadmap Roadmap
------- -------
- Pretty printer
- Control Flow Graph (CFG) - Control Flow Graph (CFG)
- PhpDocComment parser - PhpDocComment parser
- Stabilize api - Stabilize api
@ -53,11 +46,10 @@ php-parser [flags] <path> ...
| flag | type | description | | flag | type | description |
|-------|------|----------------------------------------------| |-------|------|----------------------------------------------|
| -d |string| dump format: [custom, go, json, pretty-json] | | -d |string| dump format: [custom, go, json, pretty-json] |
| -p | bool | show positions | | -r | bool | resolve names |
| -r | bool | resolve names | | -ff | bool | parse and show free floating strings |
| -prof |string| start profiler: [cpu, mem, trace] | | -prof |string| start profiler: [cpu, mem, trace] |
| -meta | bool | show meta info |
| -php5 | bool | parse as PHP5 | | -php5 | bool | parse as PHP5 |
Dump AST to stdout. Dump AST to stdout.
@ -106,79 +98,3 @@ Namespace resolver is a visitor that resolves nodes fully qualified name and sav
- For `Class`, `Interface`, `Trait`, `Function`, `Constant` nodes it saves name with current namespace. - For `Class`, `Interface`, `Trait`, `Function`, `Constant` nodes it saves name with current namespace.
- For `Name`, `Relative`, `FullyQualified` nodes it resolves `use` aliases and saves a fully qualified name. - For `Name`, `Relative`, `FullyQualified` nodes it resolves `use` aliases and saves a fully qualified name.
Parsing syntax-invalid PHP files
--------------------------------
If we try to parse `$a$b;` then the parser triggers error 'syntax error: unexpected T_VARIABLE'. Token `$b` is unexpected, but parser recovers parsing process and returns `$b;` statement to AST, because it is syntactically correct.
Pretty printer [work in progress]
---------------------------------
```Golang
nodes := &stmt.StmtList{
Stmts: []node.Node{
&stmt.Namespace{
NamespaceName: &name.Name{
Parts: []node.Node{
&name.NamePart{Value: "Foo"},
},
},
},
&stmt.Class{
Modifiers: []node.Node{
&node.Identifier{Value: "abstract"},
},
ClassName: &name.Name{
Parts: []node.Node{
&name.NamePart{Value: "Bar"},
},
},
Extends: &stmt.ClassExtends{
ClassName: &name.Name{
Parts: []node.Node{
&name.NamePart{
Value: "Baz"
},
},
},
},
Stmts: []node.Node{
&stmt.ClassMethod{
Modifiers: []node.Node{
&node.Identifier{Value: "public"},
},
MethodName: &node.Identifier{Value: "greet"},
Stmt: &stmt.StmtList{
Stmts: []node.Node{
&stmt.Echo{
Exprs: []node.Node{
&scalar.String{Value: "'Hello world'"},
},
},
},
},
},
},
},
},
}
file := os.Stdout
p := printer.NewPrinter(file, " ")
p.Print(nodes)
```
It prints to stdout:
```PHP
<?php
namespace Foo;
abstract class Bar extends Baz
{
public function greet()
{
echo 'Hello world';
}
}
```