@@ -1,6 +1,35 @@ <?php -class StaticReflector { +interface ClassCollator { + function collate($first, $second); +} + +class DummyClassCollator implements ClassCollator { + function collate($first, $second) { + return 'mixed'; + } +} + +class TraceIncludesLogger { + protected $reflector; + protected $includes = array(); + function __construct(StaticReflector $reflector) { + $this->reflector = $reflector; + } + function log($trace) { + $filename = isset($trace['filename']) ? $trace['filename'] : ''; + if (!isset($this->includes[$filename]) && is_file($filename)) { + $this->reflector->scanFile($filename); + } + $this->includes[$filename] = true; + } + function log_include($trace) { + $this->log($trace); + } +} + +class StaticReflector implements ClassCollator { protected $scanner; + protected $names = array(); protected $typemap = array(); protected $collate_cache = array(); protected $ancestors_cache = array(); @@ -12,6 +41,8 @@ class StaticReflector { $inheritance_scanner->notifyOnImplements(array($this, 'logSupertype')); } function logSupertype($class, $super) { + $this->names[strtolower($super)] = $super; + $this->names[strtolower($class)] = $class; $class = strtolower($class); $super = strtolower($super); if (!isset($this->typemap[$class])) { @@ -34,13 +65,20 @@ class StaticReflector { function export() { return $this->typemap; } + protected function symbolsToNames($symbols = array()) { + $names = array(); + foreach ($symbols as $symbol) { + $names[] = $this->names[$symbol]; + } + return $names; + } function ancestors($class) { $class = strtolower($class); - return isset($this->typemap[$class]) ? $this->typemap[$class] : array(); + return $this->symbolsToNames(isset($this->typemap[$class]) ? $this->typemap[$class] : array()); } function ancestorsAndSelf($class) { $class = strtolower($class); - return isset($this->typemap[$class]) ? array_merge(array($class), $this->typemap[$class]) : array($class); + return $this->symbolsToNames(isset($this->typemap[$class]) ? array_merge(array($class), $this->typemap[$class]) : array($class)); } function allAncestors($class) { $class = strtolower($class); @@ -55,7 +93,7 @@ class StaticReflector { return $result; } function allAncestorsAndSelf($class) { - return array_merge(array(strtolower($class)), $this->allAncestors($class)); + return array_merge(array($this->names[strtolower($class)]), $this->allAncestors($class)); } /** * Finds the first common ancestor, if possible reflector.inc.php @@ -1,10 +1,9 @@ <?php class Signatures { protected $signatures_array = array(); - function __construct($signatures_array = array()) { - foreach ($signatures_array as $name => $sig) { - $this->signatures_array[strtolower($name)] = $sig; - } + protected $collator; + function __construct(ClassCollator $collator) { + $this->collator = $collator; } function has($func, $class = "") { $name = strtolower($class ? ($class . '->' . $func) : $func); @@ -16,26 +15,24 @@ class Signatures { } $name = strtolower($class ? ($class . '->' . $func) : $func); if (!isset($this->signatures_array[$name])) { - $this->signatures_array[$name] = new FunctionSignature(); + $this->signatures_array[$name] = new FunctionSignature($this->collator); } return $this->signatures_array[$name]; } } -/** - * Signatures are collected at 3 different places (in order of authority): - * static analysis (typehints) - * runtime analysis (trace) - * docblockcomments (optional) - */ class FunctionSignature { protected $arguments = array(); protected $return_type; + protected $collator; + function __construct(ClassCollator $collator) { + $this->collator = $collator; + } function blend($arguments, $return_type) { if ($arguments) { foreach ($arguments as $id => $type) { $arg = $this->getArgumentById($id); - $arg->blendType($type); + $arg->collateWith($type); } } if ($return_type) { @@ -47,7 +44,7 @@ class FunctionSignature { } function getArgumentById($id) { if (!isset($this->arguments[$id])) { - $this->arguments[$id] = new FunctionArgument($id); + $this->arguments[$id] = new FunctionArgument($id, null, '???', $this->collator); } return $this->arguments[$id]; } @@ -69,10 +66,16 @@ class FunctionArgument { protected $id; protected $name; protected $type; - function __construct($id, $name = null, $type = '???') { + protected $collator; + function __construct($id, $name = null, $type = '???', ClassCollator $collator) { $this->id = $id; $this->name = $name; - $this->type = $type; + if ($type === 'null') { + $this->type = '???'; + } else { + $this->type = $type; + } + $this->collator = $collator; } function getId() { return $this->id; @@ -95,10 +98,37 @@ class FunctionArgument { function setType($type) { $this->type = $type; } - function blendType($type) { - // todo: could probably be more intelligent - if ($type != '???') { + function collateWith($type) { + static $primitive = array('boolean', 'string', 'array', 'integer', 'double', 'mixed'); + if ($this->type === $type) { + return; + } + if ($type === 'null') { + // todo: set this->nullable = true + return; + } + if ($this->type === '???') { $this->type = $type; + } elseif ($type != '???') { + if (in_array($type, $primitive) || in_array($this->type, $primitive)) { + $tmp = array($this->type, $type); + sort($tmp); + switch (implode(":", $tmp)) { + case 'integer:string': + case 'double:string': + $this->type = 'string'; + break; + case 'double:integer': + $this->type = 'double'; + break; + default: + $this->type = 'mixed'; + } + } else { + //$this->type = $type; + $collate = $this->collator->collate($this->type, $type); + $this->type = $collate === '*CANT_COLLATE*' ? 'mixed' : $collate; + } } } } signature.inc.php @@ -3,9 +3,10 @@ error_reporting(E_ALL | E_STRICT); /** * todo: - * blendType to use StaticReflector + xtrace_TraceIncludesLogger * xtrace -> resources .. * use static typehints for parameter types + * use docblock comments for parameter types + * merge with existing docblock comments */ // You need to have simpletest in your include_path @@ -108,32 +109,32 @@ class TestOfStaticReflector extends UnitTestCase { $reflector = new StaticReflector(); $reflector->scanString('<'.'?php class Foo implements Bar, Doink {}'); $reflector->scanString('<'.'?php class Zip implements Bar {}'); - $this->assertEqual($reflector->ancestors('Foo'), array('bar', 'doink')); - $this->assertEqual($reflector->ancestors('zip'), array('bar')); + $this->assertEqual($reflector->ancestors('Foo'), array('Bar', 'Doink')); + $this->assertEqual($reflector->ancestors('Zip'), array('Bar')); } function test_can_collate_same() { $reflector = new StaticReflector(); $reflector->scanString('<'.'?php class Foo extends Bar {}'); $reflector->scanString('<'.'?php class Zip extends Bar {}'); - $this->assertEqual($reflector->collate('foo', 'foo'), 'foo'); + $this->assertEqual($reflector->collate('Foo', 'Foo'), 'Foo'); } function test_can_collate_direct_inheritance() { $reflector = new StaticReflector(); $reflector->scanString('<'.'?php class Foo extends Bar {}'); $reflector->scanString('<'.'?php class Zip extends Bar {}'); - $this->assertEqual($reflector->collate('foo', 'zip'), 'bar'); + $this->assertEqual($reflector->collate('Foo', 'Zip'), 'Bar'); } function test_can_collate_child_to_parent() { $reflector = new StaticReflector(); $reflector->scanString('<'.'?php class Foo {}'); $reflector->scanString('<'.'?php class Bar extends Foo {}'); - $this->assertEqual($reflector->collate('foo', 'bar'), 'foo'); + $this->assertEqual($reflector->collate('Foo', 'Bar'), 'Foo'); } function test_can_collate_parent_to_child() { $reflector = new StaticReflector(); $reflector->scanString('<'.'?php class Foo {}'); $reflector->scanString('<'.'?php class Bar extends Foo {}'); - $this->assertEqual($reflector->collate('bar', 'foo'), 'foo'); + $this->assertEqual($reflector->collate('Bar', 'Foo'), 'Foo'); } } @@ -303,7 +304,6 @@ class TestOfTracer extends UnitTestCase { function test_can_execute_sandbox_code() { chdir($this->sandbox()); $output = shell_exec('php ' . escapeshellarg($this->sandbox() . '/main.php')); - //$this->dump("\n----\n" . $output . "\n----\n"); $this->assertEqual("(completed)\n", $output); } function test_can_execute_sandbox_code_with_instrumentation() { @@ -321,7 +321,7 @@ class TestOfTracer extends UnitTestCase { function test_can_parse_tracefile() { chdir($this->sandbox()); shell_exec(escapeshellcmd($this->bindir() . '/trace.sh') . " " . escapeshellarg($this->sandbox() . '/main.php')); - $sigs = new Signatures(); + $sigs = new Signatures(new DummyClassCollator()); $this->assertFalse($sigs->has('callit')); $trace = new xtrace_TraceReader(new SplFileObject($this->sandbox() . '/dumpfile.xt')); $collector = new xtrace_TraceSignatureLogger($sigs); @@ -331,10 +331,55 @@ class TestOfTracer extends UnitTestCase { function test_can_parse_class_arg() { chdir($this->sandbox()); shell_exec(escapeshellcmd($this->bindir() . '/trace.sh') . " " . escapeshellarg($this->sandbox() . '/main.php')); - $sigs = new Signatures(); + $sigs = new Signatures(new DummyClassCollator()); $trace = new xtrace_TraceReader(new SplFileObject($this->sandbox() . '/dumpfile.xt')); $collector = new xtrace_TraceSignatureLogger($sigs); $trace->process(new xtrace_FunctionTracer($collector)); $this->assertEqual('Foo', $sigs->get('callit')->getArgumentById(0)->getType()); } +} + +class TestOfCollation extends UnitTestCase { + function bindir() { + return dirname(__FILE__); + } + function sandbox() { + return dirname(__FILE__) . '/sandbox'; + } + function setUp() { + $this->curdir = getcwd(); + $dir_sandbox = $this->sandbox(); + mkdir($dir_sandbox); + $source_main = '<'.'?php' . "\n" . + 'class Foo {' . "\n" . + '}'. "\n" . + 'class Bar extends Foo {' . "\n" . + '}'. "\n" . + 'class Cuux extends Foo {' . "\n" . + '}'. "\n" . + 'function do_stuff($x) {}'. "\n" . + 'do_stuff(new Bar());'. "\n" . + 'do_stuff(new Cuux());' + ; + file_put_contents($dir_sandbox . '/main.php', $source_main); + } + function tearDown() { + chdir($this->curdir); + $dir_sandbox = $this->sandbox(); + unlink($dir_sandbox . '/main.php'); + if (is_file($dir_sandbox . '/dumpfile.xt')) { + unlink($dir_sandbox . '/dumpfile.xt'); + } + rmdir($dir_sandbox); + } + function test_can_collate_classes() { + chdir($this->sandbox()); + shell_exec(escapeshellcmd($this->bindir() . '/trace.sh') . " " . escapeshellarg($this->sandbox() . '/main.php')); + $reflector = new StaticReflector(); + $sigs = new Signatures($reflector); + $trace = new xtrace_TraceReader(new SplFileObject($this->sandbox() . '/dumpfile.xt')); + $collector = new xtrace_TraceSignatureLogger($sigs, $reflector); + $trace->process(new xtrace_FunctionTracer($collector)); + $this->assertEqual('Foo', $sigs->get('do_stuff')->getArgumentById(0)->getType()); + } } \ No newline at end of file test.php @@ -16,10 +16,11 @@ if (realpath($_SERVER['SCRIPT_FILENAME']) === __FILE__) { } // read trace - $db = new Signatures(); + $reflector = new StaticReflector(); + $sigs = new Signatures(); $trace = new xtrace_TraceReader(new SplFileObject($trace_filename)); - $collector = new xtrace_TraceSignatureLogger($db); - $trace->process(new xtrace_FunctionTracer($collector)); + $collector = new xtrace_TraceSignatureLogger($sigs, $reflector); + $trace->process(new xtrace_FunctionTracer($collector, $reflector)); // transform file $scanner = new ScannerMultiplexer(); @@ -27,7 +28,7 @@ if (realpath($_SERVER['SCRIPT_FILENAME']) === __FILE__) { $function_body_scanner = $scanner->appendScanner(new FunctionBodyScanner()); $modifiers_scanner = $scanner->appendScanner(new ModifiersScanner()); $class_scanner = $scanner->appendScanner(new ClassScanner()); - $editor = new TracerDocBlockEditor($db, $class_scanner, $function_body_scanner); + $editor = new TracerDocBlockEditor($sigs, $class_scanner, $function_body_scanner); $transformer = $scanner->appendScanner(new DocCommentEditorTransformer($function_body_scanner, $modifiers_scanner, $parameters_scanner, $editor)); $tokenizer = new TokenStreamParser(); $token_stream = $tokenizer->scan(file_get_contents($file_to_weave)); weave.php @@ -36,13 +36,11 @@ class xtrace_TraceReader { class xtrace_FunctionTracer { protected $handler; protected $stack = array(); - protected $include_functions; protected $internal_functions; function __construct($handler) { $this->handler = $handler; $defined_functions = get_defined_functions(); - $this->include_functions = array('include', 'include_once', 'require', 'require_once'); - $this->internal_functions = array_merge($defined_functions['internal'], $this->include_functions); + $this->internal_functions = array_merge($defined_functions['internal'], array('include', 'include_once', 'require', 'require_once')); } function trace_start($time) {} function trace_end($time) {} @@ -66,43 +64,30 @@ class xtrace_FunctionTracer { if (!in_array($fun_call['function'], $this->internal_functions)) { $this->handler->log($fun_call); } - if (in_array($fun_call['function'], $this->include_functions)) { - $this->handler->log_include($fun_call); - } - } -} - -class xtrace_TraceIncludesLogger { - protected $includes = array(); - function log($trace) { - $this->includes[$trace['filename']] = true; - } - function log_include($trace) { - $this->log($trace); - } - function getIncludes() { - $result = array(); - foreach (array_keys($this->includes) as $filename) { - if (is_file($filename)) { - $result[] = $filename; - } - } - return $result; } } class xtrace_TraceSignatureLogger { protected $signatures; - function __construct(Signatures $signatures) { + protected $reflector; + protected $includes = array(); + function __construct(Signatures $signatures, StaticReflector $reflector = null) { $this->signatures = $signatures; + $this->reflector = $reflector; } function log($trace) { + if ($this->reflector) { + $filename = isset($trace['filename']) ? $trace['filename'] : ''; + if (!isset($this->includes[$filename]) && is_file($filename)) { + $this->reflector->scanFile($filename); + } + $this->includes[$filename] = true; + } $sig = $this->signatures->get($trace['function']); $sig->blend( $this->parseArguments($trace['arguments']), $this->parseReturnType($trace['return_value'])); } - function log_include($trace) { /* void */ } function parseArguments($as_string) { // todo: resources .. $types = array(); xtrace.inc.php 2c1014c96df02719d7bad34cf8b0b25dfde41444 Troels Knak-Nielsen tkn@tkn-desktop-ubuntu.(none) http://github.com/troelskn/php-tracer-weaver/commit/66d6702215fc9fd03195c2b23dd8fd786cfa0206 66d6702215fc9fd03195c2b23dd8fd786cfa0206 2008-12-06T16:08:38-08:00 2008-12-06T16:08:38-08:00 Now uses static type info to collate class types 12513e14850799570435cd7de2117993bf3c1cfb Troels Knak-Nielsen tkn@tkn-desktop-ubuntu.(none)