Added support for module epilogue lines. Closes natural#6.

Troy Melhase · Troy Melhase · commit 092390731829 · 2007-02-14T13:18:29.000Z
diff --git a/lib/defaultconfig.py b/lib/defaultconfig.py
@@ -41,6 +41,13 @@
 ## in method declarations.  set to 0 to disable.
 minIndentParams = 5
 
+## Note about modulePreamble and moduleEpilogue:
+##
+## Items in both of these lists may be strings or callables.  If
+## they're callables, they should take a single argument.  The Module
+## object will be passed as this single argument in the case of
+## callables.
+
 ## lines written at the beginning of each generated module.  this value
 ## is cumulative, so when user-defined configuration modules specify
 ## this value, those lines are written after these.
@@ -50,6 +57,12 @@
     '',
     ]
 
+## lines written at the end of each generated module.  this value is
+## cumulative, so user-defined configuration modules may specify
+## additional values.
+moduleEpilogue = [
+    ]
+
 ## regular expression substitutions performed on source after
 ## generation but before final output.  this value is cumulative, so
 ## user-defined configuration modules can add augment these with their
diff --git a/lib/sourcetypes.py b/lib/sourcetypes.py
@@ -102,6 +102,7 @@ def __init__(self, parent=None, name=None):
         self.bases = []
         self.modifiers = set()
         self.preamble = []
+        self.epilogue = []
         self.lines = []        
         self.type = None
         self.variables = set()
@@ -341,6 +342,11 @@ def setName(self, name):
         self.name = name
 
     def fixSwitch(self, block):
+        """ fixes the first clause in an generated switch statement
+
+        @param block Statement instance and child of this block
+        @return None
+        """
         lines = self.lines
         if (not block in lines) or (block.name != 'if'):
             return
@@ -380,15 +386,28 @@ def writeTo(self, output, indent):
         @param indent indentation level of this block
         @return None
         """
-        for preambles in self.config.all('modulePreamble', []):
-            for line in preambles:
+        self.writeExtraLines('modulePreamble', output)
+        output.write('\n')
+        Source.writeTo(self, output, indent)
+        self.writeExtraLines('moduleEpilogue', output)
+        
+    def writeExtraLines(self, name, output):
+        """ writes an sequence of lines given a config attribute name
+
+        Lines may be callable.  Refer to the defaultconfig module for
+        details.
+        
+        @param name configuration module attribute
+        @param output writable file-like object
+        @return None
+        """
+        for lines in self.config.all(name, []):
+            for line in lines:
                 try:
                     line = line(self)
                 except (TypeError, ):
                     pass
                 output.write('%s\n' % (line, ))
-        output.write('\n')
-        Source.writeTo(self, output, indent)
 
 
 class Class(Source):
