|  | 
|  | 1 | +<?php declare(strict_types=1); | 
|  | 2 | +namespace Phan; | 
|  | 3 | + | 
|  | 4 | +use ast\Node; | 
|  | 5 | + | 
|  | 6 | +/** | 
|  | 7 | + * Debug utilities | 
|  | 8 | + */ | 
|  | 9 | +class Debug | 
|  | 10 | +{ | 
|  | 11 | + | 
|  | 12 | + /** | 
|  | 13 | + * Print a lil' something to the console to | 
|  | 14 | + * see if a thing is called | 
|  | 15 | + * | 
|  | 16 | + * @suppress PhanUnreferencedMethod | 
|  | 17 | + */ | 
|  | 18 | + public static function mark() | 
|  | 19 | + { | 
|  | 20 | + print "mark\n"; | 
|  | 21 | + } | 
|  | 22 | + | 
|  | 23 | + /** | 
|  | 24 | + * @param string|Node|null $node | 
|  | 25 | + * An AST node | 
|  | 26 | + * | 
|  | 27 | + * Print an AST node | 
|  | 28 | + * | 
|  | 29 | + * @return null | 
|  | 30 | + * | 
|  | 31 | + * @suppress PhanUnreferencedMethod | 
|  | 32 | + */ | 
|  | 33 | + public static function printNode($node) | 
|  | 34 | + { | 
|  | 35 | + print self::nodeToString($node); | 
|  | 36 | + } | 
|  | 37 | + | 
|  | 38 | + /** | 
|  | 39 | + * Print the name of a node to the terminal | 
|  | 40 | + * | 
|  | 41 | + * @suppress PhanUnreferencedMethod | 
|  | 42 | + */ | 
|  | 43 | + public static function printNodeName($node, $indent = 0) | 
|  | 44 | + { | 
|  | 45 | + print str_repeat("\t", $indent); | 
|  | 46 | + print self::nodeName($node); | 
|  | 47 | + print "\n"; | 
|  | 48 | + } | 
|  | 49 | + | 
|  | 50 | + /** | 
|  | 51 | + * Print a thing with the given indent level | 
|  | 52 | + * | 
|  | 53 | + * @suppress PhanUnreferencedMethod | 
|  | 54 | + */ | 
|  | 55 | + public static function print(string $message, int $indent = 0) | 
|  | 56 | + { | 
|  | 57 | + print str_repeat("\t", $indent); | 
|  | 58 | + print $message . "\n"; | 
|  | 59 | + } | 
|  | 60 | + | 
|  | 61 | + /** | 
|  | 62 | + * @return string | 
|  | 63 | + * The name of the node | 
|  | 64 | + */ | 
|  | 65 | + public static function nodeName($node) : string | 
|  | 66 | + { | 
|  | 67 | + if (is_string($node)) { | 
|  | 68 | + return 'string'; | 
|  | 69 | + } | 
|  | 70 | + | 
|  | 71 | + if (!$node) { | 
|  | 72 | + return 'null'; | 
|  | 73 | + } | 
|  | 74 | + | 
|  | 75 | + return \ast\get_kind_name($node->kind); | 
|  | 76 | + } | 
|  | 77 | + | 
|  | 78 | + /** | 
|  | 79 | + * @param string|Node|null $node | 
|  | 80 | + * An AST node | 
|  | 81 | + * | 
|  | 82 | + * @param int $indent | 
|  | 83 | + * The indentation level for the string | 
|  | 84 | + * | 
|  | 85 | + * @return string | 
|  | 86 | + * A string representation of an AST node | 
|  | 87 | + */ | 
|  | 88 | + public static function nodeToString( | 
|  | 89 | + $node, | 
|  | 90 | + $name = null, | 
|  | 91 | + int $indent = 0 | 
|  | 92 | + ) : string { | 
|  | 93 | + $string = str_repeat("\t", $indent); | 
|  | 94 | + | 
|  | 95 | + if ($name !== null) { | 
|  | 96 | + $string .= "$name => "; | 
|  | 97 | + } | 
|  | 98 | + | 
|  | 99 | + if (is_string($node)) { | 
|  | 100 | + return $string . $node . "\n"; | 
|  | 101 | + } | 
|  | 102 | + | 
|  | 103 | + if (!$node) { | 
|  | 104 | + return $string . 'null' . "\n"; | 
|  | 105 | + } | 
|  | 106 | + | 
|  | 107 | + if (!is_object($node)) { | 
|  | 108 | + return $string . $node . "\n"; | 
|  | 109 | + } | 
|  | 110 | + | 
|  | 111 | + $string .= \ast\get_kind_name($node->kind); | 
|  | 112 | + | 
|  | 113 | + $string .= ' [' | 
|  | 114 | + . self::astFlagDescription($node->flags ?? 0) | 
|  | 115 | + . ']'; | 
|  | 116 | + | 
|  | 117 | + if (isset($node->lineno)) { | 
|  | 118 | + $string .= ' #' . $node->lineno; | 
|  | 119 | + } | 
|  | 120 | + | 
|  | 121 | + if ($node instanceof Decl) { | 
|  | 122 | + if (isset($node->endLineno)) { | 
|  | 123 | + $string .= ':' . $node->endLineno; | 
|  | 124 | + } | 
|  | 125 | + } | 
|  | 126 | + | 
|  | 127 | + if (isset($node->name)) { | 
|  | 128 | + $string .= ' name:' . $node->name; | 
|  | 129 | + } | 
|  | 130 | + | 
|  | 131 | + $string .= "\n"; | 
|  | 132 | + | 
|  | 133 | + foreach ($node->children ?? [] as $name => $child_node) { | 
|  | 134 | + $string .= self::nodeToString( | 
|  | 135 | + $child_node, | 
|  | 136 | + $name, | 
|  | 137 | + $indent + 1 | 
|  | 138 | + ); | 
|  | 139 | + } | 
|  | 140 | + | 
|  | 141 | + return $string; | 
|  | 142 | + } | 
|  | 143 | + | 
|  | 144 | + /** | 
|  | 145 | + * @return string | 
|  | 146 | + * Get a string representation of AST node flags such as | 
|  | 147 | + * 'ASSIGN_DIV|TYPE_ARRAY' | 
|  | 148 | + */ | 
|  | 149 | + public static function astFlagDescription(int $flag) : string | 
|  | 150 | + { | 
|  | 151 | + $flag_names = []; | 
|  | 152 | + foreach (self::$AST_FLAG_ID_NAME_MAP as $id => $name) { | 
|  | 153 | + if ($flag == $id) { | 
|  | 154 | + $flag_names[] = $name; | 
|  | 155 | + } | 
|  | 156 | + } | 
|  | 157 | + | 
|  | 158 | + return implode('|', $flag_names); | 
|  | 159 | + } | 
|  | 160 | + | 
|  | 161 | + /** | 
|  | 162 | + * @return string | 
|  | 163 | + * Pretty-printer for debug_backtrace | 
|  | 164 | + * | 
|  | 165 | + * @suppress PhanUnreferencedMethod | 
|  | 166 | + */ | 
|  | 167 | + public static function backtrace(int $levels = 0) | 
|  | 168 | + { | 
|  | 169 | + $bt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, $levels+1); | 
|  | 170 | + foreach ($bt as $level => $context) { | 
|  | 171 | + if (!$level) { | 
|  | 172 | + continue; | 
|  | 173 | + } | 
|  | 174 | + echo "#".($level-1)."{$context['file']}:{$context['line']}{$context['class']}"; | 
|  | 175 | + if (!empty($context['type'])) { | 
|  | 176 | + echo $context['class'].$context['type']; | 
|  | 177 | + } | 
|  | 178 | + echo $context['function']; | 
|  | 179 | + echo "\n"; | 
|  | 180 | + } | 
|  | 181 | + } | 
|  | 182 | + | 
|  | 183 | + /** | 
|  | 184 | + * Note that flag IDs are not unique. You're likely going to get | 
|  | 185 | + * an incorrect name back from this. So sorry. | 
|  | 186 | + * | 
|  | 187 | + * @suppress PhanUnreferencedProperty | 
|  | 188 | + */ | 
|  | 189 | + private static $AST_FLAG_ID_NAME_MAP = [ | 
|  | 190 | + \ast\flags\ASSIGN_ADD => 'ASSIGN_ADD', | 
|  | 191 | + \ast\flags\ASSIGN_BITWISE_AND => 'ASSIGN_BITWISE_AND', | 
|  | 192 | + \ast\flags\ASSIGN_BITWISE_OR => 'ASSIGN_BITWISE_OR', | 
|  | 193 | + \ast\flags\ASSIGN_BITWISE_XOR => 'ASSIGN_BITWISE_XOR', | 
|  | 194 | + \ast\flags\ASSIGN_CONCAT => 'ASSIGN_CONCAT', | 
|  | 195 | + \ast\flags\ASSIGN_DIV => 'ASSIGN_DIV', | 
|  | 196 | + \ast\flags\ASSIGN_MOD => 'ASSIGN_MOD', | 
|  | 197 | + \ast\flags\ASSIGN_MUL => 'ASSIGN_MUL', | 
|  | 198 | + \ast\flags\ASSIGN_POW => 'ASSIGN_POW', | 
|  | 199 | + \ast\flags\ASSIGN_SHIFT_LEFT => 'ASSIGN_SHIFT_LEFT', | 
|  | 200 | + \ast\flags\ASSIGN_SHIFT_RIGHT => 'ASSIGN_SHIFT_RIGHT', | 
|  | 201 | + \ast\flags\ASSIGN_SUB => 'ASSIGN_SUB', | 
|  | 202 | + \ast\flags\BINARY_ADD => 'BINARY_ADD', | 
|  | 203 | + \ast\flags\BINARY_BITWISE_AND => 'BINARY_BITWISE_AND', | 
|  | 204 | + \ast\flags\BINARY_BITWISE_OR => 'BINARY_BITWISE_OR', | 
|  | 205 | + \ast\flags\BINARY_BITWISE_XOR => 'BINARY_BITWISE_XOR', | 
|  | 206 | + \ast\flags\BINARY_BOOL_XOR => 'BINARY_BOOL_XOR', | 
|  | 207 | + \ast\flags\BINARY_CONCAT => 'BINARY_CONCAT', | 
|  | 208 | + \ast\flags\BINARY_DIV => 'BINARY_DIV', | 
|  | 209 | + \ast\flags\BINARY_IS_EQUAL => 'BINARY_IS_EQUAL', | 
|  | 210 | + \ast\flags\BINARY_IS_IDENTICAL => 'BINARY_IS_IDENTICAL', | 
|  | 211 | + \ast\flags\BINARY_IS_NOT_EQUAL => 'BINARY_IS_NOT_EQUAL', | 
|  | 212 | + \ast\flags\BINARY_IS_NOT_IDENTICAL => 'BINARY_IS_NOT_IDENTICAL', | 
|  | 213 | + \ast\flags\BINARY_IS_SMALLER => 'BINARY_IS_SMALLER', | 
|  | 214 | + \ast\flags\BINARY_IS_SMALLER_OR_EQUAL => 'BINARY_IS_SMALLER_OR_EQUAL', | 
|  | 215 | + \ast\flags\BINARY_MOD => 'BINARY_MOD', | 
|  | 216 | + \ast\flags\BINARY_MUL => 'BINARY_MUL', | 
|  | 217 | + \ast\flags\BINARY_POW => 'BINARY_POW', | 
|  | 218 | + \ast\flags\BINARY_SHIFT_LEFT => 'BINARY_SHIFT_LEFT', | 
|  | 219 | + \ast\flags\BINARY_SHIFT_RIGHT => 'BINARY_SHIFT_RIGHT', | 
|  | 220 | + \ast\flags\BINARY_SPACESHIP => 'BINARY_SPACESHIP', | 
|  | 221 | + \ast\flags\BINARY_SUB => 'BINARY_SUB', | 
|  | 222 | + \ast\flags\CLASS_ABSTRACT => 'CLASS_ABSTRACT', | 
|  | 223 | + \ast\flags\CLASS_FINAL => 'CLASS_FINAL', | 
|  | 224 | + \ast\flags\CLASS_INTERFACE => 'CLASS_INTERFACE', | 
|  | 225 | + \ast\flags\CLASS_TRAIT => 'CLASS_TRAIT', | 
|  | 226 | + \ast\flags\MODIFIER_ABSTRACT => 'MODIFIER_ABSTRACT', | 
|  | 227 | + \ast\flags\MODIFIER_FINAL => 'MODIFIER_FINAL', | 
|  | 228 | + \ast\flags\MODIFIER_PRIVATE => 'MODIFIER_PRIVATE', | 
|  | 229 | + \ast\flags\MODIFIER_PROTECTED => 'MODIFIER_PROTECTED', | 
|  | 230 | + \ast\flags\MODIFIER_PUBLIC => 'MODIFIER_PUBLIC', | 
|  | 231 | + \ast\flags\MODIFIER_STATIC => 'MODIFIER_STATIC', | 
|  | 232 | + \ast\flags\NAME_FQ => 'NAME_FQ', | 
|  | 233 | + \ast\flags\NAME_NOT_FQ => 'NAME_NOT_FQ', | 
|  | 234 | + \ast\flags\NAME_RELATIVE => 'NAME_RELATIVE', | 
|  | 235 | + \ast\flags\PARAM_REF => 'PARAM_REF', | 
|  | 236 | + \ast\flags\PARAM_VARIADIC => 'PARAM_VARIADIC', | 
|  | 237 | + \ast\flags\RETURNS_REF => 'RETURNS_REF', | 
|  | 238 | + \ast\flags\TYPE_ARRAY => 'TYPE_ARRAY', | 
|  | 239 | + \ast\flags\TYPE_BOOL => 'TYPE_BOOL', | 
|  | 240 | + \ast\flags\TYPE_CALLABLE => 'TYPE_CALLABLE', | 
|  | 241 | + \ast\flags\TYPE_DOUBLE => 'TYPE_DOUBLE', | 
|  | 242 | + \ast\flags\TYPE_LONG => 'TYPE_LONG', | 
|  | 243 | + \ast\flags\TYPE_NULL => 'TYPE_NULL', | 
|  | 244 | + \ast\flags\TYPE_OBJECT => 'TYPE_OBJECT', | 
|  | 245 | + \ast\flags\TYPE_STRING => 'TYPE_STRING', | 
|  | 246 | + \ast\flags\UNARY_BITWISE_NOT => 'UNARY_BITWISE_NOT', | 
|  | 247 | + \ast\flags\UNARY_BOOL_NOT => 'UNARY_BOOL_NOT', | 
|  | 248 | + \ast\flags\BINARY_BOOL_AND => 'BINARY_BOOL_AND', | 
|  | 249 | + \ast\flags\BINARY_BOOL_OR => 'BINARY_BOOL_OR', | 
|  | 250 | + \ast\flags\BINARY_IS_GREATER => 'BINARY_IS_GREATER', | 
|  | 251 | + \ast\flags\BINARY_IS_GREATER_OR_EQUAL => 'BINARY_IS_GREATER_OR_EQUAL', | 
|  | 252 | + \ast\flags\CLASS_ANONYMOUS => 'CLASS_ANONYMOUS', | 
|  | 253 | + \ast\flags\EXEC_EVAL => 'EXEC_EVAL', | 
|  | 254 | + \ast\flags\EXEC_INCLUDE => 'EXEC_INCLUDE', | 
|  | 255 | + \ast\flags\EXEC_INCLUDE_ONCE => 'EXEC_INCLUDE_ONCE', | 
|  | 256 | + \ast\flags\EXEC_REQUIRE => 'EXEC_REQUIRE', | 
|  | 257 | + \ast\flags\EXEC_REQUIRE_ONCE => 'EXEC_REQUIRE_ONCE', | 
|  | 258 | + \ast\flags\MAGIC_CLASS => 'MAGIC_CLASS', | 
|  | 259 | + \ast\flags\MAGIC_DIR => 'MAGIC_DIR', | 
|  | 260 | + \ast\flags\MAGIC_FILE => 'MAGIC_FILE', | 
|  | 261 | + \ast\flags\MAGIC_FUNCTION => 'MAGIC_FUNCTION', | 
|  | 262 | + \ast\flags\MAGIC_LINE => 'MAGIC_LINE', | 
|  | 263 | + \ast\flags\MAGIC_METHOD => 'MAGIC_METHOD', | 
|  | 264 | + \ast\flags\MAGIC_NAMESPACE => 'MAGIC_NAMESPACE', | 
|  | 265 | + \ast\flags\MAGIC_TRAIT => 'MAGIC_TRAIT', | 
|  | 266 | + \ast\flags\UNARY_MINUS => 'UNARY_MINUS', | 
|  | 267 | + \ast\flags\UNARY_PLUS => 'UNARY_PLUS', | 
|  | 268 | + \ast\flags\UNARY_SILENCE => 'UNARY_SILENCE', | 
|  | 269 | + \ast\flags\USE_CONST => 'USE_CONST', | 
|  | 270 | + \ast\flags\USE_FUNCTION => 'USE_FUNCTION', | 
|  | 271 | + \ast\flags\USE_NORMAL => 'USE_NORMAL', | 
|  | 272 | + ]; | 
|  | 273 | +} | 
0 commit comments