Changeset 3057

Timestamp:

11/24/05 11:13:47 (8 years ago)

Author:

moschny

Message:

Use the OneLineFormatter of Trac's wiki system instead of our own
parsing routine. This has the advantage that the toc entries can
contain any wiki syntax element recognized by the OneLineFormatter.

This should close #247 and #252, although the collapse/expand
mechanism currently doesn't work for pages referenced indirectly
through references to any of their paragraphs.

File:

• trac/trunk/wiki-macros/TracNav.py (modified) (5 diffs)

trac/trunk/wiki-macros/TracNav.py

@@ -73 +73 @@
 from trac.wiki.api import WikiSystem
 from trac.wiki.model import WikiPage
-
-LISTRULE = re.compile(r"""^(?P<indent> *)\* +"""
-                      r"""(?:(?P<wikilink>\[wiki:"""
-                      r"""(?P<link>(&#34;([^&#34;]*)&#34;|"""
-                      r"""'([^']*)')|([^ \]]+))"""
-                      r"""+(?P<label>[^\]]*)\])|(?P<text>.*))""",
-                      re.M)
+from trac.wiki.formatter import OneLinerFormatter
+from StringIO import StringIO
 
 TRACNAVHOME = "http://svn.ipd.uka.de/trac/javaparty/wiki/TracNav"
+LISTRULE = re.compile(r"^(?P<indent> +)\* +(?P<rest>.*)$", re.M)
 
 def get_toc(hdf, env, curpage, name):
-    """Fetch the wiki page containing the toc, if available."""
-    
-    toc_text = "* Table of contents"
+    """
+    Fetch the wiki page containing the toc, if available.
+    """
+    toc_text = " * Table of contents"
 
     preview = hdf.getValue('args.preview', "")
     if preview and (name == curpage):
         toc_text = hdf.getValue('wiki.page_source', toc_text);
-    else:
-        if WikiSystem(env).has_page(name):
-            toc_text = WikiPage(env, name).text
-
-    # env.log.debug(tocText)
+    elif WikiSystem(env).has_page(name):
+        toc_text = WikiPage(env, name).text
     return toc_text
 
 
-def get_toc_entry(toc_text):
-    """Generator: returns the next toc entry. Each toc entry consists
-    of it's indentation level, label and link."""
-    next_pos = 0
-    while 1:
-        match = LISTRULE.search(toc_text, next_pos)
-        if not match:
-            # env.log.debug("No more matches")
-            return
-
+class TocFormatter(OneLinerFormatter):
+    """
+    Basically the OneLinerFormatter, but additionally remembers the
+    last wiki link.
+    """
+
+    def format_toc(self, wikitext, out):
+        OneLinerFormatter.format(self, wikitext, out)
+        return self.link
+
+    def __init__(self, env):
+        OneLinerFormatter.__init__(self, env)
+        self.link = None
+        self.myenv = env
+
+    def _make_link(self, namespace, target, match, label):
+        if namespace == 'wiki':
+            self.link = target
+        return OneLinerFormatter._make_link(
+            self, namespace, target, match, label)
+
+    # FIXME: what about _make_relative_link() ?
+    # FIXME: CamelCase links are special and not handled by the Formatter...
+
+def format_toc_entry(wikitext, env):
+    out = StringIO()
+    link = TocFormatter(env).format_toc(wikitext, out)
+    return out.getvalue(), link
+
+
+def get_toc_entry(toc_text, env):
+    """
+    Filter the toc_text for toc entries.
+    """
+    for match in LISTRULE.finditer(toc_text):
         indent = len(match.group('indent'))
-        if match.group('wikilink'):
-            link = match.group('link')
-            label = match.group('label')
-        else:
-            link = None
-            label = match.group('text')
-
-        # if link == None:
-        #     env.log.debug(label + " ---")
-        # else:
-        #     env.log.debug(label + ": " + link)
-    
+        label, link = format_toc_entry(match.group('rest'), env)
+        # env.log.debug("link is '%s'" % link)
         yield indent, link, label
-        next_pos = match.end()
 
 
 def get_toc_entry_and_indent(gen):
-    """Generator, to be used as a filter for get_toc_entry().  Returns
-    link and label of the current toc entry and the indentation level
-    of the next entry or -1 if there are no more entries. The first
-    call to next() returns the indentation of the first entry."""
-    
+    """
+    Filter for get_toc_entry().  Returns link and label of the current
+    toc entry and the indentation level of the next entry or -1 if
+    there are no more entries. The first call to next() returns the
+    indentation of the first entry.
+    """
     try:
         indent, link, label = gen.next()
@@ -152 +161 @@
     if next_indent > level:
         sublist, next_indent = _parse_toc(gen, next_indent, level + 1)
-        if next_indent < level:
-            # level is empty
+        if next_indent < level: # level is empty
             return sublist, next_indent
-        else:
-            # broken indentation structure
+        else:                   # broken indentation structure
             toclist.append((None, None, sublist))
     while 1:
@@ -171 +178 @@
 
 
-def parse_toc(toc_text):
-    gen = get_toc_entry_and_indent(get_toc_entry(toc_text))
+def parse_toc(toc_text, env):
+    gen = get_toc_entry_and_indent(get_toc_entry(toc_text, env))
     toclist, _ = _parse_toc(gen, gen.next())
     return toclist
@@ -184 +191 @@
         name = 'TOC'
 
-    toc = parse_toc(get_toc(hdf, env, curpage, name))
+    toc = parse_toc(get_toc(hdf, env, curpage, name), env)
     if not toc:
         msg = '<div class="system-message">' \
@@ -255 +262 @@
             else:
                 cls = ''
-            html += '%s<li%s%s>' % (indentation(col), li_style, cls)
-            if name == None:
-                html += title
-            else:
-                html += '<a href="%s">%s</a>' % (env.href.wiki(name), title)
-            html += '</li>\n'
+            html += '%s<li%s%s>%s</li>\n' % \
+                    (indentation(col), li_style, cls, title)
         else:
             html += '%s<li%s>\n' % (indentation(col), li_style)
             col += 1
-            if name == None or len(sub) > 0:
-                html += '%s<h4>%s</h4>\n' % (indentation(col), title)
-            else:
-                html += '%s<h4><a href="%s">%s</a>...</h4>\n' % \
-                        (indentation(col), env.href.wiki(name), title)
+            if name == None or sub:
+                html += '%s<h4>%s</h4>\n' % \
+                        (indentation(col), title)
+            else:
+                html += '%s<h4>%s...</h4>\n' % \
+                        (indentation(col), title)
             col -= 1
             html += '%s</li>\n' % indentation(col)