Changeset 935

Timestamp:

Jun 15, 2012 1:06:35 PM (11 years ago)

Author:

jemian

Message:

refs #8, now handles cdef (still needs to parse additional arguments properly), Index entries are much improved, now gathers definitions together in index

Location:

specdomain/src/specdomain

Files:

• sphinxcontrib/specdomain.py (modified) (3 diffs)
• test/starter.py (modified) (1 diff)
• test/test_doc.rst (modified) (2 diffs)
• test/tester.py (modified) (2 diffs)
• test/tester2.py (added)

specdomain/src/specdomain/sphinxcontrib/specdomain.py

@@ -28 +28 @@
 
 
+match_all                   = '.*'
+non_greedy_filler           = match_all+'?'
+double_quote_string_match   = '("'+non_greedy_filler+'")'
+word_match                  = '((?:[a-z_][\w]*))'
+cdef_match                  = '(cdef)'
+
+
 spec_macro_sig_re = re.compile(
     r'''^ ([a-zA-Z_]\w*)         # macro name
           ''', re.VERBOSE)
+
+spec_func_sig_re = re.compile(word_match+'\('
+                      + '('+match_all+')' 
+                      + '\)', 
+                      re.IGNORECASE|re.DOTALL)
+
+spec_cdef_name_sig_re = re.compile(double_quote_string_match, re.IGNORECASE|re.DOTALL)
 
 
@@ -49 +63 @@
     def _get_index_text(self, name):
         macro_types = {
-            'def':  '%s (SPEC macro)',
-            'rdef': '%s (SPEC run-time macro)',
-            'cdef': '%s (SPEC chained macro)',
+            'def':  'SPEC macro definition; %s',
+            'rdef': 'SPEC run-time macro definition; %s',
+            'cdef': 'SPEC chained macro definition; %s',
         }
         if self.objtype in macro_types:
@@ -64 +78 @@
         #     def macro_name(arg1, arg2)
         #     rdef macro_name
-        #     cdef(macro_name, content, groupname, flags)
-        m = spec_macro_sig_re.match(sig)
+        #     cdef("macro_name", "content", "groupname", flags)
+        m = spec_func_sig_re.match(sig) or spec_macro_sig_re.match(sig)
         if m is None:
             raise ValueError
-        arglist = sig.strip().split()
-        if len(arglist) == 0:
-            raise ValueError
-        if sig.startswith('cdef'):
-            special = sig.lstrip('cdef')
+        arglist = m.groups()
         name = arglist[0]
+        args = []
+        if len(arglist) > 1:
+            args = arglist[1:]
+            if name == 'cdef':
+                # TODO: need to match complete arg list
+                # several different signatures are possible (see cdef-examples.mac)
+                # for now, just get the macro name and ignore the arg list
+                m = spec_cdef_name_sig_re.match(args[0])
+                arglist = m.groups()
+                name = arglist[0].strip('"')
+                args = []                       # FIXME:
         signode += addnodes.desc_name(name, name)
-        if len(arglist) > 1:
-            args = sig.lstrip(name).strip()
         if len(args) > 0:
             signode += addnodes.desc_addname(args, args)

specdomain/src/specdomain/test/starter.py

@@ -19 +19 @@
     :param str parent: path to *build* subdirectory (either ``build`` or ``_build``)
     '''
-    if os.path.exists(parent):
+    if os.path.exists(parent+'/doctrees'):
         garbage_list = [
             parent+'/doctrees/environment.pickle',

specdomain/src/specdomain/test/test_doc.rst

@@ -26 +26 @@
    This is a standard SPEC macro definition.
 
+.. spec:def:: def_function(arguments)
+
+   :param str arguments: named argument(s) to this function
+
 .. spec:rdef:: rdef_macro content
 
    This is a SPEC macro definition with symbols that are evaluated only at run-time.
 
-.. spec:cdef:: cdef(macro_name, [content, groupname, [flags]])
+.. spec:cdef:: cdef("cdef_macro", "content", "cdef_part", flags)
 
-   :param str macro_name: one-word name (quoted string) for this macro chain
+   :param str cdef_macro: one-word name (quoted string) for this macro chain
    :param str content: SPEC code to be inserted (typically a single macro)
-   :param str groupname: name of organizational group
+   :param str cdef_part: name for this part of the chained macro
    :param str flags: see the manual
 
@@ -69 +73 @@
 
 * macro definition: :spec:def:`def_macro`
+* function definition: :spec:def:`def_function(arguments)`
 * runtime-defined macro definition: :spec:rdef:`rdef_macro`
-* chained macro definition: :spec:cdef:`cdef(macro_name, content, groupname, flags)`
+* chained macro definition: :spec:cdef:`cdef("cdef_macro", "content", "cdef_part", flags)`
 
 SPEC Variables

specdomain/src/specdomain/test/tester.py

@@ -7 +7 @@
 
 #  http://regexpal.com/
-#http://www.txt2re.com/index-python.php3
+#  http://www.txt2re.com/index-python.php3
 
 def tester(test_cases, regexp):
@@ -120 +120 @@
 func_start_re = re.compile(word_match+'\(',
                       re.IGNORECASE|re.DOTALL)
+func_match_re = re.compile(word_match+'\('
+                      + '('+match_all+')' 
+                      + '\)', 
+                      re.IGNORECASE|re.DOTALL)
 # cdef1_re is most general for recognizing any of the different cdef signatures
-tester(test_cases, cdef1_re)
+# func_match_re is most general for recognizing any of the different cdef signatures
+tester(test_cases, func_match_re)
+
+
+##################################################################################
+
+txt='\'"macro_name", "content", "groupname", flags\''
+
+uninteresting_csv = non_greedy_filler+','
+csv_match = '(' + non_greedy_filler + '),'
+
+re_str=non_greedy_filler        # Non-greedy match on filler
+re_str += double_quote_string   # Double Quote String 1
+re_str += non_greedy_filler     # Non-greedy match on filler
+re_str += uninteresting_csv     # Uninteresting: csv
+re_str += non_greedy_filler     # Non-greedy match on filler
+re_str += csv_match             # Command Seperated Values 1
+re_str += non_greedy_filler     # Non-greedy match on filler
+re_str += uninteresting_csv     # Uninteresting: csv
+re_str += non_greedy_filler     # Non-greedy match on filler
+re_str += csv_match             # Command Seperated Values 2
+
+re_str = "(.*)"
+
+rg = re.compile(re_str, re.IGNORECASE|re.DOTALL)
+
+test_cases = '''
+'"macro_name", "commands", "partname", "delete"'
+'"macro_name", "commands", "partname", flags'
+'"cleanup_once", sprintf("dscan_cleanup $1 %s;", _c1), "dscan"'
+'"macro_name", "commands", "partname"'
+'"macro_name"'
+'"geo_ub_default", "", "ub.mac"'
+'"config_mac", "{PLOT_CNTRS_MAX = COUNTERS}", "PLOT_Y", 0x10'
+'''
+print re_str
+tester(test_cases, rg)