annotate vendor/nikic/php-parser/bin/php-parse @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 5fb285c0d0e3
children
rev   line source
Chris@0 1 #!/usr/bin/env php
Chris@0 2 <?php
Chris@0 3
Chris@0 4 foreach ([__DIR__ . '/../../../autoload.php', __DIR__ . '/../vendor/autoload.php'] as $file) {
Chris@0 5 if (file_exists($file)) {
Chris@0 6 require $file;
Chris@0 7 break;
Chris@0 8 }
Chris@0 9 }
Chris@0 10
Chris@0 11 ini_set('xdebug.max_nesting_level', 3000);
Chris@0 12
Chris@0 13 // Disable XDebug var_dump() output truncation
Chris@0 14 ini_set('xdebug.var_display_max_children', -1);
Chris@0 15 ini_set('xdebug.var_display_max_data', -1);
Chris@0 16 ini_set('xdebug.var_display_max_depth', -1);
Chris@0 17
Chris@0 18 list($operations, $files, $attributes) = parseArgs($argv);
Chris@0 19
Chris@0 20 /* Dump nodes by default */
Chris@0 21 if (empty($operations)) {
Chris@0 22 $operations[] = 'dump';
Chris@0 23 }
Chris@0 24
Chris@0 25 if (empty($files)) {
Chris@0 26 showHelp("Must specify at least one file.");
Chris@0 27 }
Chris@0 28
Chris@13 29 $lexer = new PhpParser\Lexer\Emulative(['usedAttributes' => [
Chris@0 30 'startLine', 'endLine', 'startFilePos', 'endFilePos', 'comments'
Chris@13 31 ]]);
Chris@0 32 $parser = (new PhpParser\ParserFactory)->create(
Chris@0 33 PhpParser\ParserFactory::PREFER_PHP7,
Chris@0 34 $lexer
Chris@0 35 );
Chris@0 36 $dumper = new PhpParser\NodeDumper([
Chris@0 37 'dumpComments' => true,
Chris@0 38 'dumpPositions' => $attributes['with-positions'],
Chris@0 39 ]);
Chris@0 40 $prettyPrinter = new PhpParser\PrettyPrinter\Standard;
Chris@0 41
Chris@0 42 $traverser = new PhpParser\NodeTraverser();
Chris@0 43 $traverser->addVisitor(new PhpParser\NodeVisitor\NameResolver);
Chris@0 44
Chris@0 45 foreach ($files as $file) {
Chris@0 46 if (strpos($file, '<?php') === 0) {
Chris@0 47 $code = $file;
Chris@0 48 echo "====> Code $code\n";
Chris@0 49 } else {
Chris@0 50 if (!file_exists($file)) {
Chris@0 51 die("File $file does not exist.\n");
Chris@0 52 }
Chris@0 53
Chris@0 54 $code = file_get_contents($file);
Chris@0 55 echo "====> File $file:\n";
Chris@0 56 }
Chris@0 57
Chris@0 58 if ($attributes['with-recovery']) {
Chris@0 59 $errorHandler = new PhpParser\ErrorHandler\Collecting;
Chris@0 60 $stmts = $parser->parse($code, $errorHandler);
Chris@0 61 foreach ($errorHandler->getErrors() as $error) {
Chris@0 62 $message = formatErrorMessage($error, $code, $attributes['with-column-info']);
Chris@0 63 echo $message . "\n";
Chris@0 64 }
Chris@0 65 if (null === $stmts) {
Chris@0 66 continue;
Chris@0 67 }
Chris@0 68 } else {
Chris@0 69 try {
Chris@0 70 $stmts = $parser->parse($code);
Chris@0 71 } catch (PhpParser\Error $error) {
Chris@0 72 $message = formatErrorMessage($error, $code, $attributes['with-column-info']);
Chris@0 73 die($message . "\n");
Chris@0 74 }
Chris@0 75 }
Chris@0 76
Chris@0 77 foreach ($operations as $operation) {
Chris@0 78 if ('dump' === $operation) {
Chris@0 79 echo "==> Node dump:\n";
Chris@0 80 echo $dumper->dump($stmts, $code), "\n";
Chris@0 81 } elseif ('pretty-print' === $operation) {
Chris@0 82 echo "==> Pretty print:\n";
Chris@0 83 echo $prettyPrinter->prettyPrintFile($stmts), "\n";
Chris@13 84 } elseif ('json-dump' === $operation) {
Chris@13 85 echo "==> JSON dump:\n";
Chris@13 86 echo json_encode($stmts, JSON_PRETTY_PRINT), "\n";
Chris@0 87 } elseif ('var-dump' === $operation) {
Chris@0 88 echo "==> var_dump():\n";
Chris@0 89 var_dump($stmts);
Chris@0 90 } elseif ('resolve-names' === $operation) {
Chris@0 91 echo "==> Resolved names.\n";
Chris@0 92 $stmts = $traverser->traverse($stmts);
Chris@0 93 }
Chris@0 94 }
Chris@0 95 }
Chris@0 96
Chris@0 97 function formatErrorMessage(PhpParser\Error $e, $code, $withColumnInfo) {
Chris@0 98 if ($withColumnInfo && $e->hasColumnInfo()) {
Chris@0 99 return $e->getMessageWithColumnInfo($code);
Chris@0 100 } else {
Chris@0 101 return $e->getMessage();
Chris@0 102 }
Chris@0 103 }
Chris@0 104
Chris@0 105 function showHelp($error = '') {
Chris@0 106 if ($error) {
Chris@0 107 echo $error . "\n\n";
Chris@0 108 }
Chris@0 109 die(<<<OUTPUT
Chris@0 110 Usage: php-parse [operations] file1.php [file2.php ...]
Chris@0 111 or: php-parse [operations] "<?php code"
Chris@0 112 Turn PHP source code into an abstract syntax tree.
Chris@0 113
Chris@0 114 Operations is a list of the following options (--dump by default):
Chris@0 115
Chris@0 116 -d, --dump Dump nodes using NodeDumper
Chris@0 117 -p, --pretty-print Pretty print file using PrettyPrinter\Standard
Chris@13 118 -j, --json-dump Print json_encode() result
Chris@0 119 --var-dump var_dump() nodes (for exact structure)
Chris@0 120 -N, --resolve-names Resolve names using NodeVisitor\NameResolver
Chris@0 121 -c, --with-column-info Show column-numbers for errors (if available)
Chris@0 122 -P, --with-positions Show positions in node dumps
Chris@0 123 -r, --with-recovery Use parsing with error recovery
Chris@0 124 -h, --help Display this page
Chris@0 125
Chris@0 126 Example:
Chris@0 127 php-parse -d -p -N -d file.php
Chris@0 128
Chris@0 129 Dumps nodes, pretty prints them, then resolves names and dumps them again.
Chris@0 130
Chris@0 131
Chris@0 132 OUTPUT
Chris@0 133 );
Chris@0 134 }
Chris@0 135
Chris@0 136 function parseArgs($args) {
Chris@13 137 $operations = [];
Chris@13 138 $files = [];
Chris@13 139 $attributes = [
Chris@0 140 'with-column-info' => false,
Chris@0 141 'with-positions' => false,
Chris@0 142 'with-recovery' => false,
Chris@13 143 ];
Chris@0 144
Chris@0 145 array_shift($args);
Chris@0 146 $parseOptions = true;
Chris@0 147 foreach ($args as $arg) {
Chris@0 148 if (!$parseOptions) {
Chris@0 149 $files[] = $arg;
Chris@0 150 continue;
Chris@0 151 }
Chris@0 152
Chris@0 153 switch ($arg) {
Chris@0 154 case '--dump':
Chris@0 155 case '-d':
Chris@0 156 $operations[] = 'dump';
Chris@0 157 break;
Chris@0 158 case '--pretty-print':
Chris@0 159 case '-p':
Chris@0 160 $operations[] = 'pretty-print';
Chris@0 161 break;
Chris@13 162 case '--json-dump':
Chris@13 163 case '-j':
Chris@13 164 $operations[] = 'json-dump';
Chris@0 165 break;
Chris@0 166 case '--var-dump':
Chris@0 167 $operations[] = 'var-dump';
Chris@0 168 break;
Chris@0 169 case '--resolve-names':
Chris@0 170 case '-N';
Chris@0 171 $operations[] = 'resolve-names';
Chris@0 172 break;
Chris@0 173 case '--with-column-info':
Chris@0 174 case '-c';
Chris@0 175 $attributes['with-column-info'] = true;
Chris@0 176 break;
Chris@0 177 case '--with-positions':
Chris@0 178 case '-P':
Chris@0 179 $attributes['with-positions'] = true;
Chris@0 180 break;
Chris@0 181 case '--with-recovery':
Chris@0 182 case '-r':
Chris@0 183 $attributes['with-recovery'] = true;
Chris@0 184 break;
Chris@0 185 case '--help':
Chris@0 186 case '-h';
Chris@0 187 showHelp();
Chris@0 188 break;
Chris@0 189 case '--':
Chris@0 190 $parseOptions = false;
Chris@0 191 break;
Chris@0 192 default:
Chris@0 193 if ($arg[0] === '-') {
Chris@0 194 showHelp("Invalid operation $arg.");
Chris@0 195 } else {
Chris@0 196 $files[] = $arg;
Chris@0 197 }
Chris@0 198 }
Chris@0 199 }
Chris@0 200
Chris@13 201 return [$operations, $files, $attributes];
Chris@0 202 }