Changeset 435 for topdoc

Timestamp:

Apr 1, 2011 1:52:41 PM (14 years ago)

Author:

jemian

Message:

refactored macro substitution - expect to obey ALL EPICS rules now from AppDevGuide? Chap. 6

File:

• topdoc/src/TopDoc/utilities.py (modified) (4 diffs)

topdoc/src/TopDoc/utilities.py ¶

@@ -20 +20 @@
 
 
-COMMENT_PATTERN = re.compile(
-        r'//.*?$|/\*.*?\*/|\'(?:\\.|[^\\\'])*\'|"(?:\\.|[^\\"])*"',
+C_LANGUAGE_COMMENT_RE = r'//.*?$|/\*.*?\*/|\'(?:\\.|[^\\\'])*\'|"(?:\\.|[^\\"])*"'
+C_LANGUAGE_COMMENT_PATTERN = re.compile(
+        C_LANGUAGE_COMMENT_RE,
         re.DOTALL | re.MULTILINE
     )
+
+# a-z A-Z 0-9 _ -- : . [ ] < > ;
+EPICS_UNQUOTED_STRING_RE = r'[\d\w_:;.<>\-\[\]]+'
+EPICS_MACRO_SPECIFICATION_P_RE = "\$\("+EPICS_UNQUOTED_STRING_RE+"\)"
+EPICS_MACRO_SPECIFICATION_B_RE = "\$\{"+EPICS_UNQUOTED_STRING_RE+"\}"
+# EPICS_MACRO_DEFAULT_RE cannot find $(P=$(S)), that's OK.
+# If the inner $(S) was expanded, it would be found then, else macro expansion fails anyway
+EPICS_MACRO_DEFAULT_RE = EPICS_UNQUOTED_STRING_RE+'='+EPICS_UNQUOTED_STRING_RE
+EPICS_MACRO_SPECIFICATION_PD_RE = "\$\("+EPICS_MACRO_DEFAULT_RE+"\)"
+EPICS_MACRO_SPECIFICATION_BD_RE = "\$\{"+EPICS_MACRO_DEFAULT_RE+"\}"
+
+EPICS_UNQUOTED_STRING_PATTERN = re.compile(EPICS_UNQUOTED_STRING_RE, 0)
+EPICS_MACRO_SPECIFICATION_P_PATTERN = re.compile(EPICS_MACRO_SPECIFICATION_P_RE, 0)
+EPICS_MACRO_SPECIFICATION_B_PATTERN = re.compile(EPICS_MACRO_SPECIFICATION_B_RE, 0)
+EPICS_MACRO_DEFAULT_PATTERN = re.compile(EPICS_MACRO_DEFAULT_RE, 0)
+EPICS_MACRO_SPECIFICATION_PD_PATTERN = re.compile(EPICS_MACRO_SPECIFICATION_PD_RE, 0)
+EPICS_MACRO_SPECIFICATION_BD_PATTERN = re.compile(EPICS_MACRO_SPECIFICATION_BD_RE, 0)
 
 
@@ -39 +57 @@
         else:
             return s
-    return re.sub(COMMENT_PATTERN, replacer, text)
+    return re.sub(C_LANGUAGE_COMMENT_PATTERN, replacer, text)
 
 
@@ -81 +99 @@
     @return: string with substitutions applied
     '''
-    target = source
-    # diagnostic lines only
-    # logMessage("replaceMacros(): source = " + source)
-    # logMessage("replaceMacros(): macros = " + str(macros))
-    # TODO: It's more complicated than this.  See comment in TopDoc.py
-    for k, v in macros.items():
-        if target.find("$(") < 0:
-            break
-        key = "$(%s)" % k
-        tmp = target.replace(key, v)
-        target = tmp
-    return target
+    while True:
+        replacement_found = False
+        # substitute the simple macro replacements
+        for patt in (EPICS_MACRO_SPECIFICATION_P_PATTERN, EPICS_MACRO_SPECIFICATION_B_PATTERN):
+            for subst_marker in re.findall(patt, source, 0):
+                parts = re.findall(EPICS_UNQUOTED_STRING_PATTERN, subst_marker, 0)
+                if len(parts) != 1:
+                    # add more diagnostics if this happens
+                    raise Exception, "should only match 1 substitution expression here"
+                if parts[0] in macros:
+                    replacement_text = macros[parts[0]]
+                    replacement_found = True
+                    source = source.replace(subst_marker, replacement_text)
+        # substitute the macros with default expressions
+        for patt in (EPICS_MACRO_SPECIFICATION_PD_PATTERN, EPICS_MACRO_SPECIFICATION_BD_PATTERN):
+            for subst_marker in re.findall(patt, source, 0):
+                parts = re.findall(EPICS_UNQUOTED_STRING_PATTERN, subst_marker, 0)
+                if len(parts) != 2:
+                    # add more diagnostics if this happens
+                    raise Exception, "should only match 2 parts here"
+                macro_variable, default_substitution = parts
+                if macro_variable in macros:
+                    replacement_text = macros[macro_variable]
+                else:
+                    replacement_text = default_substitution
+                replacement_found = True
+                source = source.replace(subst_marker, replacement_text)
+        if not replacement_found:
+            break       # nothing more can be done
+    return source
 
 
@@ -168 +204 @@
 if __name__ == '__main__':
     print "need some test and demo function calls"
+    macro_test_set = ("$(P=$(S))${S_$(P)}string  $(PJ=$(P))${S_$(P)}string  ${_P:9--8}  $(<_.>=bob:) $(P=blue) $(P=red)",
+                      "$(P=$(S))${S_$(P)}string",
+                      "$(PJ=$(P))${S_$(P)}string",
+                      "${_P:9--8}",
+                      "$(<_.>=bob:)",
+                      "$(P=blue)",
+                      "$(P=red)"
+                      )
+    macros = {'P': 'pete:', 'S_pete:': 'shoe_'}
+    for test in macro_test_set:
+        print replaceMacros(test, macros)