Changeset 904

Timestamp:

Jun 11, 2012 5:23:30 PM (11 years ago)

Author:

jemian

Message:

work-in-progress

Location:

specdomain/src

Files:

• sphinxcontrib/specdomain.py (modified) (7 diffs)
• test/autodoc.rst (modified) (1 diff)
• test/hints.rst (added)
• test/index.rst (modified) (1 diff)
• test/testbarrier.mac (modified) (1 diff)

specdomain/src/sphinxcontrib/specdomain.py

@@ -49 +49 @@
           ''', re.VERBOSE)
 
+spec_global_sig_re = re.compile(
+    r'''^ ([\w.]*:)?             # module name
+          ([A-Z]\w+) $           # thing name
+          ''', re.VERBOSE)
+
 
 spec_var_sig_re = re.compile(
@@ -63 +68 @@
 
 spec_paramlist_re = re.compile(r'([\[\],])')  # split at '[', ']' and ','
+
+
+
+#### re parts that recognize the start of a macro definition (def or rdef)
+# # ^
+# # [\s]*
+# # [r]?
+# # def
+# # [\s]+
+# # ([a-zA-Z_][\w]*)
+# #
+#### re parts that recognize the start of a chained macro definition (cdef)
+# # ^
+# # [\s]*
+# # cdef
+# # \(
+#
+# def _ascan ''
+#
+# kohzuMove_PV = "32ida:KohzuPutBO"
+# Und_Delay = 0.1
+#
+# def kohzuE_cmd(mne,key,p1) '{
+#      if (key == "set_position") {
+#       return
+#      }
+# }'
+#
+# def show_und'
+#    printf("\n%40.40s","Curent Undulator Status")
+# '
+#
+#   # cleanup macro for ^C usage
+#   rdef _cleanup3 \'resetUSAXS\'
+#   rdef _cleanup3 \'\'
+#      cdef("Fheader", fheader,  "UCOL", 0x20)
+#      rdef Flabel \'""\'
+
+
+#### re parts that recognize a global variable declaration
+# ^                                    # start of line
+# ([\s]*)                              # optional preceding white space
+# global                               # "global" declaration
+# ([\s]+[@]?[a-zA-Z_][\w]*(\[\])?)+    # one or more variable names
+# ([\s]+#.*)*                          # optional comment
+# $                                    # end of line
+
+# global  BCDA_GM[]
+# 
+#    global    billy[]
+#    global    9billy[]
+#    global    _billy[]
+# 
+# global kohzu_PV kohzuMV_PV UND_PV Und_Off UNDE_TRACK_ON
+# global       kohzuStop_PV kohzuMode_PV      kohzuMove_PV
+# global CCD_PREFIX            # EPICS PV for CCD server
+# global CCD_OVERHEAD_SECS        # readout time
+# global CCD_OVERHEAD_SECS_MEASURED   # measured readout time
+# 
+#     global @A_name[] @B_name[]
+#        unglobal @A_name
+#        unglobal @B_name
+# global CCD_DARK_NUM CCDDARK CCD_THROW
+# global MULTI_IMGS # useful 8-ID's imm fileformat; currently not used
 
 
@@ -180 +249 @@
         elif self.objtype == 'macro':
             return _('%s (SPEC macro)') % name
+        elif self.objtype == 'global':
+            return _('%s (SPEC global)') % name
         elif self.objtype == 'record':
             return _('%s (SPEC record)') % name
@@ -387 +458 @@
         'function': ObjType(l_('function'), 'func'),
         'macro':    ObjType(l_('macro'),    'macro'),
+        'global':   ObjType(l_('global'),   'global'),
         'record':   ObjType(l_('record'),   'record'),
         'module':   ObjType(l_('module'),   'mod'),
@@ -397 +469 @@
         'module':        SpecModule,
         'variable':      SpecVariable,
+        'global':        SpecVariable,
         'currentmodule': SpecCurrentModule,
     }
@@ -402 +475 @@
         'func' :  SpecXRefRole(),
         'macro':  SpecXRefRole(),
+        'global': SpecXRefRole(),
         'record': SpecXRefRole(),
         'mod':    SpecXRefRole(),
@@ -409 +483 @@
         'functions' : {}, # fullname -> arity -> (targetname, docname)
         'modules': {},    # modname -> docname, synopsis, platform, deprecated
+        'globals': {},    # ??????????
     }
     indices = [

specdomain/src/test/autodoc.rst

@@ -19 +19 @@
 
 .. note:: tba
-
+.. awk language support requires Pygments 1.5+
 .. literalinclude:: newuser.mac
         :language: guess
         :linenos:
-
+        

specdomain/src/test/index.rst

@@ -11 +11 @@
    test_doc
    autodoc
-   
+   hints
+
+
+Objectives
+-----------
+
+A. Document SPEC macro source code files
+
+  #. macro definitions (def, rdef, and cdef)
+  #. function definitions
+  #. global variable definitions
+  #. local variable definitions
+  #. array variable definitions
+  #. constant definitions
+  #. ReST-formatted comments (usually contain API or usage info)
+  #. optional source code highlighting
+  
+B. Build cross-referenced WWW site and PDF documentation
+C. Provide a test file for development.
+D. Provide useful examples in documentation.
+
+
 Indices and tables
 ==================

specdomain/src/test/testbarrier.mac

@@ -207 +207 @@
 
 def show_und'
-   printf("\n%40.40s","Curent Undulator Status")
+   printf("\n%40.40s","Current Undulator Status")
 '