[Scummvm-cvs-logs] SF.net SVN: scummvm: [28652] tools/branches/gsoc2007-decompiler/finalD/ README

[brixxie at users.sourceforge.net]

Revision: 28652
          http://scummvm.svn.sourceforge.net/scummvm/?rev=28652&view=rev
Author:   brixxie
Date:     2007-08-18 00:02:55 -0700 (Sat, 18 Aug 2007)

Log Message:
-----------
Added preliminary README

Added Paths:
-----------
    tools/branches/gsoc2007-decompiler/finalD/README

Added: tools/branches/gsoc2007-decompiler/finalD/README
===================================================================
--- tools/branches/gsoc2007-decompiler/finalD/README	                        (rev 0)
+++ tools/branches/gsoc2007-decompiler/finalD/README	2007-08-18 07:02:55 UTC (rev 28652)
@@ -0,0 +1,40 @@
+                              <>
+                              ==
+
+<> is a bytecode decompiler written in Python. Its code
+structuring algorithms work on an intermediary representation
+of a script's instructions and hence are bytecode variant independent.
+Thus, adding support for a new bytecode variant only involves
+writing a new frontend containing code to translate bytecode
+instructions to the intermediary format.
+
+<> does not yet analyze data flow and hence there is no true
+(as in viable/sensible) support for stack-based bytecode variants
+as of now.
+
+------------------------------------------------------------------------
+Requirements:
+
+  - Python >=2.3 (I _think_)
+  - altgraph (http://cheeseshop.python.org/pypi/altgraph/)
+  - [optional] graphviz
+
+------------------------------------------------------------------------
+Usage:
+
+$ <> [options] <script>
+
+Current options are:
+
+  -d: Generate a simple disassembly of the program.
+  -g: Display a control flow graph using 'dotty'
+      from the graphviz package.
+
+------------------------------------------------------------------------
+Todo:
+
+  - Implement basic data flow analysis for the parameter stack of
+    stack-based bytecode variants.
+  - Implement support for SCUMM versions >=6
+
+------------------------------------------------------------------------


Property changes on: tools/branches/gsoc2007-decompiler/finalD/README
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.