Changeset 139

Timestamp:

10/08/07 10:06:59 (6 years ago)

Author:

mgalloy

Message:

Listing procedures, functions, and variables in sav files. Still need to work on common blocks, pointer, objects, structure definitions, and system variables.

Location:

trunk/idldoc/src

Files:

• doc_system__define.pro (modified) (2 diffs)
• introspection/doc_thumbnail.pro (modified) (1 diff)
• resources/main.css (modified) (1 diff)
• templates/savefile.tt (modified) (3 diffs)
• tree/doctreesavfile__define.pro (modified) (6 diffs)
• tree/doctreesavvar__define.pro (modified) (5 diffs)

trunk/idldoc/src/doc_system__define.pro

@@ -75 +75 @@
 
 
-pro doc_system::getProperty, root=root
+pro doc_system::getProperty, root=root, output=output
   compile_opt strictarr
 
   if (arg_present(root)) then root = self.root
+  if (arg_present(output)) then output = self.output
 end
 
@@ -88 +89 @@
   compile_opt strictarr
   
-  print, 'ROOT = ' + self.root
-  print, 'OUTPUT = ' + self.output
 end
 

trunk/idldoc/src/introspection/doc_thumbnail.pro

@@ -197 +197 @@
   ; calculate dimensions that preserve aspect ratio, but are in the range
   ; minDimSize...maxDimSize
-  dims = [sz.dimensions[cind[0]], sz.dimensions[cind[1]]]
-  dims = long(dims / float(max(dims)) * maxDimSize)
+  origDims = [sz.dimensions[cind[0]], sz.dimensions[cind[1]]]
+  dims = long(origDims / float(max(origDims)) * maxDimSize)
+  
+  ; only resize to smaller, never bigger
+  doResize = total(dims gt origDims) eq 0
+  
   dims = dims > minDimSize < maxDimSize
   
-  im = congrid(im, sz.dimensions[ind[0]], dims[0], dims[1])
+  if (doResize) then begin
+    im = congrid(im, sz.dimensions[ind[0]], dims[0], dims[1])
+  endif
   
   return, im

trunk/idldoc/src/resources/main.css

@@ -42 +42 @@
 dl.routine-summary dd { margin-bottom: 0.5em; margin-left: 2em; }
 
-/* table */
+/* general styles */
+ul li { list-style-type: none; }
 table { empty-cells: show; }
 

trunk/idldoc/src/templates/savefile.tt

@@ -66 +66 @@
       <table class="attribute smaller">      
         <tr>
-          <td class="name">Procedures: </td>
+          <td class="name">[% IF n_procedure gt 0%]<a href="#procedures">[% END %]Procedures:[% IF n_procedure gt 0 %]</a>[% END %]</td>
           <td>[% n_procedure %]</td>
         </tr>  
         <tr>
-          <td class="name">Functions: </td>
+          <td class="name">[% IF n_function gt 0 %]<a href="#functions">[% END %]Functions:[% IF n_function gt 0 %]</a>[% END %]</td>
           <td>[% n_function %]</td>
         </tr> 
         <tr>
-          <td class="name">Variables: </td>
+          <td class="name">[% IF n_var gt 0 %]<a href="#vars">[% END %]Variables:[% IF n_var gt 0 %]</a>[% END %]</td>
           <td>[% n_var %]</td>
         </tr>  
@@ -98 +98 @@
         </tr>  
       </table>
+            
+      [% IF n_procedure gt 0 %]
+      <div id="procedures">
+        <h3>Procedures</h3>
+        
+        <ul class="smaller">
+          [% FOREACH p IN procedures %]
+          <li>[% p %]</li>
+          [% END %]
+        </ul>
+      </div>
+      [% END %]
+
+      [% IF n_function gt 0 %]
+      <div id="functions">
+        <h3>Functions</h3>
+        
+        <ul class="smaller">
+          [% FOREACH f IN functions %]
+          <li>[% f %]</li>
+          [% END %]
+        </ul>
+      </div>
+      [% END %]
+            
+      [% IF n_var gt 0 %]
+      <div id="vars">
+        <h3>Variables</h3>
+        
+        <table class="smaller">
+        [% FOREACH v IN vars %][% SCOPE v %]
+          <tr>
+            <td>[% IF has_thumbnail %]<img src="[% thumbnail_url %]"/>[% END %]</td>
+            <td>[% name %]</td>
+            <td><code>[% declaration %]</code></td>             
+          </tr>
+        [% END %][% END %]
+        </table>
+      </div>
+      [% END %]
       
       <h2>File attributes</h2>
@@ -111 +151 @@
             <td>[% size %]</td>
           </tr>          
-        </table      
+        </table>   
         
     </div>

trunk/idldoc/src/tree/doctreesavfile__define.pro

@@ -53 +53 @@
         contents = self.savFile->contents()
         ind = where(strupcase(name) eq tag_names(contents))
-        return, contents.(ind[0])
+        val = contents.(ind[0])
+        return, (size(val, /type) eq 3 or size(val, /type) eq 14) ? mg_int_format(val) : val
       end
+    'vars': return, self.vars->get(/all)
+    'procedures': return, self.procedures->get(/all)
+    'functions': return, self.functions->get(/all)
     else: begin
         ; search in the system object if the variable is not found here
@@ -70 +74 @@
 ; Get properties.
 ;-
-pro doctreesavfile::getProperty, basename=basename
-  compile_opt strictarr
-  
-  if (arg_present(basename)) then name = self.basename
+pro doctreesavfile::getProperty, basename=basename, directory=directory
+  compile_opt strictarr
+  
+  if (arg_present(basename)) then basename = self.basename
+  if (arg_present(directory)) then directory = self.directory
+end
+
+
+function doctreesavfile::loadItem, itemName, _extra=e
+  compile_opt strictarr
+  
+  self.savFile->restore, itemName, _strict_extra=e
+  
+  return, scope_varfetch(itemName)
+end
+
+
+pro doctreesavfile::loadSavContents
+  compile_opt strictarr
+
+  procedureNames = self.savFile->names(count=nProcedures, /procedure)
+  if (nProcedures gt 0) then self.procedures->add, procedureNames
+  
+  functionNames = self.savFile->names(count=nFunctions, /function)
+  if (nFunctions gt 0) then self.functions->add, functionNames
+  
+  varNames = self.savFile->names(count=nVars)
+  for i = 0L, nVars - 1L do begin
+    data = self->loadItem(varNames[i])
+    
+    var = obj_new('DOCtreeSavVar', varNames[i], data, self, system=self.system)
+    self.vars->add, var
+  endfor
 end
 
@@ -90 +123 @@
   on_error, 2
   
-  print, '  Generating output for .sav file ' + self.basename
+  self.system->print, '  Generating output for .sav file ' + self.basename
+  
+  self->loadSavContents
   
   savFileTemplate = self.system->getTemplate('savefile')
@@ -108 +143 @@
   compile_opt strictarr
   
-  obj_destroy, self.savFile
+  obj_destroy, [self.procedures, self.functions, self.vars, self.savFile]
 end
 
@@ -140 +175 @@
   self.system->createIndexEntry, self.basename, self
   self.system->print, '  Parsing ' + self.basename + '...'
+  
+  self.procedures = obj_new('MGcoArrayList', type=7)
+  self.functions = obj_new('MGcoArrayList', type=7)
+  self.vars = obj_new('MGcoArrayList', type=11)
   
   return, 1
@@ -165 +204 @@
              savFile: obj_new(), $
              modificationTime: '', $
-             size: '' $
+             size: '', $
+             
+             procedures: obj_new(), $
+             functions: obj_new(), $
+             vars: obj_new() $
            }
 end

trunk/idldoc/src/tree/doctreesavvar__define.pro

@@ -13 +13 @@
 ;       set to a named variable, returns if variable name was found
 ;-
-function doctreesavfile::getVariable, name, found=found
+function doctreesavvar::getVariable, name, found=found
   compile_opt strictarr
   
@@ -19 +19 @@
   switch strlowcase(name) of
     'name': return, self.name
+    'declaration': return, self.declaration
+    'has_thumbnail': return, self.hasThumbnail
     'thumbnail_url': begin
-        ; TODO: finish this
-        return, self.savFile->getVariable('url')
+        return, self.savFile->getVariable('url') + self.localThumbnailUrl
       end
     else: begin
@@ -41 +42 @@
   compile_opt strictarr
 
-  ptr_free, self.thumbnail
 end
 
@@ -53 +53 @@
   
   im = doc_thumbnail(data, valid=valid)
-  if (valid) then self.thumbnail = ptr_new(im)
+  self.hasThumbnail = valid
+  if (self.hasThumbnail) then begin 
+    self.savFile->getProperty, directory=directory, basename=basename
+    directory->getProperty, location=location
+    self.system->getProperty, output=output
+    self.localThumbnailUrl = file_basename(basename, '.sav') + '-sav-' + self.name + '.png'
+    filename = output + location + self.localThumbnailUrl
+    
+    write_png, filename, im
+  endif
+  
+  self.declaration = doc_variable_declaration(data)
   
   return, 1
@@ -67 +78 @@
              
              name: '', $
-             thumbnail: ptr_new() $
+             declaration: '', $
+             localThumbnailUrl: '', $
+             hasThumbnail: 0B $
            }
 end