Changeset 64

Timestamp:

09/25/07 16:28:23 (6 years ago)

Author:

mgalloy

Message:

Capable of producing listing files for each directory.

Location:

trunk/idldoc/src

Files:

• doc_system__define.pro (modified) (4 diffs)
• tree/doctreedirectory__define.pro (modified) (3 diffs)
• tree/doctreesavfile__define.pro (modified) (3 diffs)

trunk/idldoc/src/doc_system__define.pro

@@ -32 +32 @@
 
 
-pro doc_system::getProperty, root=root, sav_file_template=savFileTemplate
+pro doc_system::getProperty, root=root, $
+                             listing_template=listingTemplate, $
+                             sav_file_template=savFileTemplate
   compile_opt strictarr
 
   if (arg_present(root)) then root = self.root
+  if (arg_present(listingTemplate)) then listingTemplate = self.listingTemplate
   if (arg_present(savFileTemplate)) then savFileTemplate = self.savFileTemplate
 end
@@ -133 +136 @@
      self.directories->add, directory
   endfor
+end
+
+
+function doc_system::createTemplate, basename
+  compile_opt strictarr
+  
+  templateFilename = filepath(basename, $
+                              subdir=['templates'], $
+                              root=self.sourceLocation) 
+  return, obj_new('MGffTemplate', templateFilename)
+end
+
+
+pro doc_system::loadTemplates
+  compile_opt strictarr
+  
+  self.listingTemplate = self->createTemplate('listing.tt')
+  self.savFileTemplate = self->createTemplate('savefile.tt')
 end
 
@@ -319 +340 @@
   
   ; load templates
-  templateFilename = filepath('savefile.tt', $
-                              subdir=['templates'], $
-                              root=self.sourceLocation)
-  self.savFileTemplate = obj_new('MGffTemplate', templateFilename)
+  self->loadTemplates
   
   ; parse tree of directories, files, routines, parameters 
@@ -361 +379 @@
              sourceLocation: '', $
              directories: obj_new(), $  
+             listingTemplate: obj_new(), $
              savFileTemplate: obj_new(), $  
              title: '', $

trunk/idldoc/src/tree/doctreedirectory__define.pro

@@ -1 @@
-pro doctreedirectory::getProperty, location=location, relative_root=relativeRoot
+pro doctreedirectory::getProperty, location=location
   compile_opt strictarr
   
   if (arg_present(location)) then location = self.location
-  if (arg_present(relativeRoot)) then begin
-    dummy = strsplit(self.location, path_sep(), count=nUps)
-    relativeRoot = strjoin(replicate('..' + path_sep(), nUps))
-  endif
+end
+
+
+function doctreedirectory::getVariable, name, found=found
+  compile_opt strictarr
+
+  found = 1B
+  case strlowcase(name) of
+    'location' : return, self.location
+    'relative_root' : begin
+        dummy = strsplit(self.location, path_sep(), count=nUps)
+        return, strjoin(replicate('..' + path_sep(), nUps))
+      end
+    else: begin
+        ; search in the system object if the variable is not found here
+        var = self.system->getVariable(name, found=found)
+        if (found) then return, var
+        
+        found = 0B
+        return, -1L
+      end
+  endcase
 end
 
@@ -22 +40 @@
   
   print, 'Generating output for ' + self.location
-  
+
+  ; create directory in the output if necessary
+  outputDir = outputRoot + self.location
+  if (~file_test(outputDir)) then begin
+    self.system->makeDirectory, outputDir, error=error
+    if (error ne 0L) then begin
+      self.system->error, 'unable to make directory ' + outputDir
+    endif
+  endif
+    
   ; generate docs for each .pro/.sav/.idldoc file in directory
   for f = 0L, self.proFiles->count() - 1L do begin
@@ -42 +69 @@
   
   ; generate file listing
+  listingFilename = filepath('dir-files.html', root=outputDir)
+  self.system->getProperty, listing_template=listingTemplate
+  listingTemplate->reset
+  listingTemplate->process, self, listingFilename
 end
 

trunk/idldoc/src/tree/doctreesavfile__define.pro

@@ -28 +28 @@
   switch strlowcase(name) of
     'basename' : return, self.basename
-    'relative_root' : begin
-        self.directory->getProperty, relative_root=relativeRoot
-        return, relativeRoot
-      end
     'creation_date': begin
         contents = self.savFile->contents()
@@ -58 +54 @@
     else: begin
         ; search in the system object if the variable is not found here
-        var = self.system->getVariable(name, found=found)
+        var = self.directory->getVariable(name, found=found)
         if (found) then return, var
         
@@ -96 +92 @@
   
   outputDir = outputRoot + directory
-  if (~file_test(outputDir)) then begin
-    self.system->makeDirectory, outputDir, error=error
-    if (error ne 0L) then begin
-      self.system->error, 'unable to make directory ' + outputDir
-    endif
-  endif
   outputFilename = outputDir + file_basename(self.basename, '.sav') + '-sav.html'
   
+  savFileTemplate->reset
   savFileTemplate->process, self, outputFilename
 end