Changeset 1226

Timestamp:

09/01/06 08:28:40 (2 years ago)

Author:

Blackhex

Message:

DoxygenPlugin:

more_fixes-r1216.diff patch applied.

Files:

• doxygenplugin/0.10/doxygentrac/doxygentrac.py (modified) (8 diffs)
• doxygenplugin/0.10/doxygentrac/htdocs/css/doxygen.css (modified) (2 diffs)

doxygenplugin/0.10/doxygentrac/doxygentrac.py

@@ -19 +19 @@
-  add_stylesheet
-from trac.Search import ISearchSource
-
-
+
+
+
-from trac.util.html import html
-
@@ -61 +62 @@
-      """Default encoding used by the generated documentation files.""")
-
+    SUMMARY_PAGES = """
+    annotated classes dirs files functions globals hierarchy
+    index inherits main namespaces namespacemembers
+    """.split()
+
-    # IPermissionRequestor methods
-
@@ -74 +80 @@
-        if req.perm.has_permission('DOXYGEN_VIEW'):
-            # Return mainnav buttons.
-html.a(self.title,
-
+\
+    html.a(self.title, 
-
-    # IRequestHandler methods
-
-    def match_request(self, req):
-        ext = '|'.join(self.ext.split(' '))
-        source_ext = '|'.join(self.source_ext.split(' '))
-
-        # Match documentation request.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-            return True
-
-
-
-
-
+
-    def process_request(self, req):
-        req.perm.assert_permission('DOXYGEN_VIEW')
@@ -173 +106 @@
-        action = req.args.get('action')
-
-
-
+
-
-        # Redirect search requests.
-        if action == 'search':
- = 
-doxygen = 
-
-Retrun apropriate content to type or search
-el
+=
+                           doxygen=
+
+Handle /doxygen
+
-            if self.wiki_index:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-                return 'doxygen.cs', 'text/html'
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-
-    # ITemplateProvider methods
@@ -261 +181 @@
-
-    # IWikiSyntaxProvider
+    
-    def get_link_resolvers(self):
-
+
+
+
+
+
+
+
+
+
-
-    def get_wiki_syntax(self):
@@ -268 +197 @@
-
-    # internal methods
+
+    def _doxygen_lookup(self, segments):
+        """Try to interpret path components as a request for doxygen targets
+
+        Return an `(action,path,link)` pair, where:
+         - `action` describes what should be done (one of 'view',
+           'search' or 'index'),
+         - `path` is the location on disk of the resource.
+         - `link` is the link to the resource, relative to the
+           req.href.doxygen base,
+        """
+        doc, file = segments[:-1], segments and segments[-1]
+        doc = doc and os.path.join(*doc) or self.default_doc
+        def lookup(file, category='undefined'):
+            path = os.path.join(self.base_path, doc, file)
+            self.log.debug('%s file "%s" (at %s)' % (category, file, path))
+            return os.path.exists(path) and path, doc + '/' + file
+
+        if not file:
+            path, link = lookup('index.html', 'index')
+            return 'index', path, link
+
+        self.log.debug('looking up "%s" in documentation "%s"' % (file, doc))
+
+        # Direct request for searching
+        if file == 'search.php':
+            return 'search', None, None
+
+        # Request for a documentation file.
+        doc_ext_re = '|'.join(self.ext.split(' '))
+        if re.match(r'''^(.*)[.](%s)''' % doc_ext_re, file):
+            path, link = lookup(file, 'documentation')
+            if path:
+                return 'view', path, link
+            else:
+                return 'search', file, None
+
+        # Request for source file documentation.
+        source_ext_re = '|'.join(self.source_ext.split(' '))
+        match = re.match(r'''^(.*)[.](%s)''' % source_ext_re, file)
+        if match:
+            basename, suffix = match.groups()
+            basename = basename.replace('_', '__')
+            path, link = lookup('%s_8%s.html' % (basename, suffix), 'source')
+            if path:
+                return 'view', path, link
+            else:
+                return 'search', file, None
+
+        # Request for summary pages
+        if file in self.SUMMARY_PAGES:
+            path, link = lookup(file + '.html', 'summary')
+            if path:
+                return 'view', path, link
+
+        # Request for a named object
+        # TODO:
+        #  - do something about dirs
+        #  - expand with enum, defs, etc.
+        #  - this doesn't work well with the CREATE_SUBDIRS Doxygen option
+        path, link = lookup('class%s.html' % file, 'class')
+        if not path:
+            path, link = lookup('struct%s.html' % file, 'struct')
+        if path:
+            return 'view', path, link
+
+        # Revert to search...
+        results = self._search_in_documentation(doc, [file])
+        class_ref = file+' Class Reference'
+        for result in results:
+            self.log.debug('Reverted to search, found: ' + repr(result))
+            name = result['name']
+            if name == file or name == class_ref:
+                path, link = lookup(result['url'])
+                return 'redirect', path, link
+        self.log.debug('%s not found in %s' % (file, doc))
+        return 'search', file, None
+
-    def _search_in_documentation(self, doc, keywords):
-        # Open index file for documentation
@@ -343 +350 @@
-                        results[i]['rank'] = float(freq*multi) \
-                          / float(totalFreq)
-
-        return results
-
@@ -376 +382 @@
-        return result
-
-    def _doxygen_link(self, formatter, ns, params, label):
-        if ns == 'doxygen':
-            return html.a(label, href = formatter.href.doxygen(params),
-              title = params)
-        else:
-            return html.a(label, href = formatter.href.doxygen(),
-              title = params, class_ = 'missing')

doxygenplugin/0.10/doxygentrac/htdocs/css/doxygen.css

@@ -7 +7 @@
-{
-  display: block;
-em
-em
+
+ 0 0
-  font-size: 10px;
-  list-style: none;
@@ -17 +17 @@
-{
-  border-right: 1px solid #d7d7d7;
-em
+
-  white-space: nowrap;
-}
+
+div.tabs form
+{
+  float: right;
+}
+
+div.tabs label, div.tabs input
+{ 
+  padding: 0 0.75em;
+  font-size: 10px;
+}
+
+div#main div.nav
+{ 
+  margin: 0;
+  padding: 1em 0 0 0.75em;
+}
+
+h1
+{ 
+  margin: 1em;
+}