Changes between Version 62 and Version 63 of Orio

Timestamp:

06/13/08 16:37:37 (15 years ago)

Author:

hartono

Comment:

--

Orio

@@ -231 +231 @@
 == Developer Guide ==
 
-This section covers topics on how to extend Orio with new components such as program transformation modules.
+This section covers topics on how to extend Orio with new features and components such as program transformation modules.
 
 == Writing a New Code Transformation Module ==
 
-With the module name provided in the leader annotation, Orio dynamically loads the corresponding code transformation module and uses it to transform and generate the code in the annotation body block. If the pertinent module cannot be found in the Orio module directory, an error message is produced, and the Orio optimization process is terminated. The ''name-based dynamic loading'' provides flexibility and easy extensibility without requiring detailed knowledge or modification of the existing Orio system.
-
+With the module name provided in the leader annotation, Orio dynamically loads the corresponding code transformation module and uses it to transform and generate the code in the annotation body block. If the pertinent module cannot be found in the Orio module directory, an error message is produced, and the Orio optimization process is terminated. Such ''name-based dynamic loading'' provides flexibility and easy extensibility without requiring detailed knowledge or modification of the existing Orio system.
+
+Since Orio implementation is all in Python, to construct a new program transformation module therefore requires a Python programming skill. Transformation module writers need to create a new Python module inside `src/module` directory, where the abstract base class of the code transformation modules is located. This abstract class serves as a partial implementation of the source-to-source transformation process that inherits a class constructor and an abstract transformation function, which both need to be implemented in the newly created module subclass.
+
+{{{
+# 
+# The abstract class of the Orio's code transformation module 
+# 
+ 
+class Module: 
+    '''The abstract class of the Orio's code transformation module''' 
+     
+    def __init__(self, cmd_line_opts, perf_params, module_code, line_no, indent_size, annot_body_code): 
+        ''' 
+        To instantiate a program transformation module used to transform the annotated code. 
+ 
+        The class variables consist of the following: 
+           cmd_line_opts      an object representing the command line options 
+                              (see src/cmd_line_opts.py for more details) 
+           perf_params        a table/mapping that maps each performance parameter to its value 
+           module_code        the code of annotation module body 
+           line_no            the starting line position of the module code in the source code 
+           indent_size        an integer representing the number of space characters used in the 
+                              indentation of the leader annotation 
+           annot_body_code    the text located in the annotation body block 
+           verbose            to show details of the results of the running transformation modules 
+        ''' 
+ 
+        self.cmd_line_opts = cmd_line_opts 
+        self.perf_params = perf_params 
+        self.module_code = module_code 
+        self.line_no = line_no 
+        self.indent_size = indent_size 
+        self.annot_body_code = annot_body_code 
+ 
+        # a boolean value 
+        self.verbose = self.cmd_line_opts.verbose 
+ 
+    #-------------------------------------------------------------------- 
+         
+    def transform(self): 
+        ''' 
+        The main code transformation procedure. 
+        The returned value is a string value that represents the transformed/optimized code. 
+        ''' 
+         
+        raise NotImplementedError('%s: unimplemented abstract function "transform"' % 
+                                  (self.__class__.__name__)) 
+}}}
 
 ''Currently under construction''