Changeset 592

Timestamp:

04/21/09 15:46:34 (3 years ago)

Author:

mgalloy

Message:

Added links to routine and class names found in Uses section of routine and file docs.

Location:

trunk/idldoc

Files:

• docs/RELEASE (modified) (1 diff)
• src/doc_system__define.pro (modified) (4 diffs)
• src/tree/doctreeclass__define.pro (modified) (1 diff)
• src/tree/doctreeprofile__define.pro (modified) (2 diffs)
• src/tree/doctreeroutine__define.pro (modified) (1 diff)

trunk/idldoc/docs/RELEASE

@@ -22 +22 @@
   2 for level 1 items plus parameters, keywords, fields, properties, and sav
   file variables
+
+* Adds links to names of routines and classes found in the Uses section for 
+  routines and files.
 
 * Miscellaneous small bug fixes.

trunk/idldoc/src/doc_system__define.pro

@@ -549 +549 @@
 
 ;+
+; Add a routine to the visible routines list.
+; 
+; :Params:
+;    name : in, required, type=string
+;       name of routine
+;    routine : in, required, type=object
+;       DOCtreeRoutine object
+;-
+pro doc_system::addVisibleRoutine, name, routine
+  compile_opt strictarr
+
+  self.visibleRoutines->put, strlowcase(name), routine
+end
+
+
+;+
+; Find link to given resource.
+; 
+; :Returns:
+;    string, returns empty string if no resource found
+;    
+; :Params:
+;    resource : in, required, type=string   
+;-
+function doc_system::_findResourceLink, resource
+  compile_opt strictarr
+  
+  class = self.classes->get(strlowcase(resource), found=found)
+  if (found) then begin
+    if (class->hasUrl()) then return, class->getUrl()
+  endif
+  
+  routine = self.visibleRoutines->get(strlowcase(resource), found=found)
+  if (found) then begin
+    return, routine->getVariable('index_url')
+  endif
+  
+  return, ''
+end
+
+
+;+
+; Convert the uses clause into a string array using the current comment style.
+; 
+; :Returns:
+;    strarr
+;
+; :Params:
+;    tree : in, required, type=object
+;       parse tree object
+;  
+; :Keywords:
+;    root : in, required, type=string
+;       relative location of root from the calling routine or file
+;-
+function doc_system::processUses, tree, root=root
+  compile_opt strictarr
+  
+  if (~obj_valid(tree)) then return, ''
+  
+  ; get plain text
+  crlf = string(!version.os_family eq 'unix' ? [10B] : [13B, 10B])
+  plainParser = self->getParser('plainoutput')
+  s = plainParser->process(tree)
+  s = strjoin(s, crlf)
+  resources = strsplit(s, '[[:space:],]', /regex, /extract, count=nresources)
+  
+  ; get new tree based with links to resources used
+  _tree = obj_new('MGtmTag', type='paragraph')
+  for r = 0L, nresources - 1L do begin
+    href = self->_findResourceLink(resources[r])
+    if (href eq '') then begin
+      parent = _tree
+    endif else begin
+      link = obj_new('MGtmTag', type='link')
+      link->addAttribute, 'reference', root + '/' + href
+      _tree->addchild, link
+      parent = link
+    endelse
+    
+    resourceName = obj_new('MGtmText', text=resources[r])
+    parent->addChild, resourceName
+    
+    if (r ne nresources - 1L) then begin
+      comma = obj_new('MGtmText', text=', ')
+      _tree->addChild, comma
+    endif
+  endfor
+
+  ; create output using current comment style
+  commentParser = self->getParser(self.commentStyle + 'output')
+  comments = commentParser->process(_tree)
+    
+  ; destroy new tree
+  obj_destroy, _tree
+  
+  return, comments
+end
+
+
+;+
 ; Convert a parse tree into a string array using the plain output parser.
 ;
@@ -968 +1069 @@
   
   obj_destroy, [self.index, self.proFiles, self.dlmFiles, self.savFiles, self.idldocFiles]
+  obj_destroy, self.visibleRoutines
   
   classes = self.classes->values(count=nClasses)
@@ -1187 +1289 @@
   self.savFiles = obj_new('MGcoArrayList', type=11, block_size=20)  
   self.idldocFiles = obj_new('MGcoArrayList', type=11, block_size=20)
+  
+  self.visibleRoutines = obj_new('MGcoHashTable', key_type=7, value_type=11)
   
   self.requiresItems = obj_new('MGcoArrayList', type=11, block_size=20)
@@ -1377 +1481 @@
              idldocFiles: obj_new(), $
              
+             visibleRoutines: obj_new(), $
+             
              requiresVersion: '', $
              requiresItems: obj_new() $                              

trunk/idldoc/src/tree/doctreeclass__define.pro

@@ -103 +103 @@
 
 ;+
-; Easy to use accessor for URL.
-;
-; :Returns: string
+; Easy to use accessor for URL to class file relative to doc root.
+;
+; :Returns: 
+;    string
 ;-
 function doctreeclass::getUrl

trunk/idldoc/src/tree/doctreeprofile__define.pro

@@ -372 +372 @@
         
     'has_uses': return, obj_valid(self.uses)
-    'uses': return, self.system->processComments(self.uses)
+    'uses': begin
+        self.directory->getProperty, url=dirUrl
+        if (dirUrl eq './') then begin
+          root = '.'
+        endif else begin
+          dummy = strsplit(dirUrl, '/', count=ndirs)
+          root = strjoin(strarr(ndirs) + '..', '/')
+        endelse
+        return, self.system->processUses(self.uses, root=root)
+      end
 
     'plain_attributes': begin
@@ -529 +538 @@
     routine->markArguments
     routine->checkDocumentation
+    routine->getProperty, name=routineName
+    if (routine->isVisible()) then begin
+      self.system->addVisibleRoutine, routineName, routine
+    endif
   endfor
 end

trunk/idldoc/src/tree/doctreeroutine__define.pro

@@ -342 +342 @@
 
     'has_uses': return, obj_valid(self.uses)
-    'uses': return, self.system->processComments(self.uses)
-                            
+    'uses': begin
+        self.file->getProperty, directory=directory
+        directory->getProperty, url=dirUrl
+        if (dirUrl eq './') then begin
+          root = '.'
+        endif else begin
+          dummy = strsplit(dirUrl, '/', count=ndirs)
+          root = strjoin(strarr(ndirs) + '..', '/')
+        endelse
+        return, self.system->processUses(self.uses, root=root)
+      end
+                           
     'has_requires': return, obj_valid(self.requires)
     'requires': return, self.system->processComments(self.requires)