Changeset 961

Timestamp:

Jun 21, 2012 4:39:57 PM (11 years ago)

Author:

jemian

Message:

refs #8

Location:

specdomain/src/specdomain/sphinxcontrib

Files:

• specdomain.py (modified) (6 diffs)
• specmacrofileparser.py (copied) (copied from specdomain/src/specdomain/test/specmacrofileparser.py)

specdomain/src/specdomain/sphinxcontrib/specdomain.py

@@ -145 +145 @@
     Description of a SPEC variable
     """
+    
+    # TODO: The directive that declares the variable should be the primary (bold) index.
+    # TODO: array variables are not handled at all
 
 
@@ -207 +210 @@
         highlighted source code blocks.
         '''
-        extended_comments_list = self.parse_macro_file(sig)
-        view = ViewList([u'TODO: recognize the ReST formatting in the following extended comment and it needs to be cleaned up'])
+        #extended_comments_list = self.parse_macro_file(sig)
+        view = ViewList([u'TODO: Just handle the macro signature, additional documentation elsewhere'])
         #contentnode = nodes.TextElement()
         node = nodes.paragraph()
@@ -224 +227 @@
         return sig
     
-    def XX_run(self):
+    def run(self):
         # TODO: recognize the ReST formatting in the following extended comment and it needs to be cleaned up
         # nodes.TextElement(raw, text)
         # sphinx.directives.__init__.py  ObjectDescription.run() method
-        #  Summary:  This does not belong here, in the signature processing part.
-        #            Instead, it goes at the directive.run() method.  This is the new place!
-        pass
+        #  Summary:  This belongs with the directive.run() method.  This is the new place!
+        #self.content.append(u'')
+        #self.content.append(u'.. caution:: Use caution.')
+        from specmacrofileparser import SpecMacrofileParser
+        macrofile = self.arguments[0]
+        p = SpecMacrofileParser(macrofile)
+        return ObjectDescription.run(self)
     
     def parse_macro_file(self, filename):
@@ -298 +305 @@
     label = 'SPEC, http://www.certif.com'
     object_types = {    # type of object that a domain can document
-        'def':    ObjType(l_('def'),    'def'),
-        'rdef':   ObjType(l_('rdef'),   'rdef'),
-        'cdef':   ObjType(l_('cdef'),   'cdef'),
-        'global': ObjType(l_('global'), 'global'),
-        'local':  ObjType(l_('local'),  'local'),
+        'def':        ObjType(l_('def'),        'def'),
+        'rdef':       ObjType(l_('rdef'),       'rdef'),
+        'cdef':       ObjType(l_('cdef'),       'cdef'),
+        'global':     ObjType(l_('global'),     'global'),
+        'local':      ObjType(l_('local'),      'local'),
+        'constant':   ObjType(l_('constant'),   'constant'),
+        'macrofile':  ObjType(l_('macrofile'),  'macrofile'),
     }
     directives = {
@@ -310 +319 @@
         'global':       SpecVariableObject,
         'local':        SpecVariableObject,
+        'constant':     SpecVariableObject,
         'macrofile':    SpecMacroSourceObject,
     }
@@ -318 +328 @@
         'global':   SpecXRefRole(),
         'local':    SpecXRefRole(),
+        'constant': SpecXRefRole(),
     }
     initial_data = {