Changeset 210

Timestamp:

10/22/10 18:46:49 (14 years ago)

Author:

tim

Message:

beginnings of pyregfi documentation build script

Files:

• Doxyfile.pyregfi (added)
• Doxyfile.regfi (modified) (11 diffs)
• trunk/python/pyregfi/__init__.py (modified) (14 diffs)

Doxyfile.regfi

@@ -26 +26 @@
 # by quotes) that should identify the project.
 
-PROJECT_NAME           = reglookup
+PROJECT_NAME           = regfi
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
@@ -215 +215 @@
 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
-# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+# use: inc=Fortran f=C. Note that for custom extensions you also need to set
+# FILE_PATTERNS otherwise the files are not read by doxygen.
 
 EXTENSION_MAPPING      =
@@ -412 +413 @@
 SORT_BRIEF_DOCS        = NO
 
-# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort
+# the (brief and detailed) documentation of class members so that constructors
+# and destructors are listed first. If set to NO (the default) the
+# constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief
+# docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if
+# SORT_MEMBER_DOCS is set to NO.
 
 SORT_MEMBERS_CTORS_1ST = NO
@@ -575 +582 @@
 # with spaces.
 
-INPUT                  = trunk/lib trunk/include
+INPUT                  = trunk/lib trunk/include trunk/python/pyregfi
 
 # This tag can be used to specify the character encoding of the source files
@@ -831 +838 @@
 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
 # it at startup.
-# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for
+# more information.
 
 GENERATE_DOCSET        = NO
@@ -924 +932 @@
 QHP_CUST_FILTER_NAME   =
 
-# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
+# custom filter to add.For more information please see
 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
 
@@ -948 +957 @@
 # files needs to be copied into the plugins directory of eclipse. The name of
 # the directory within the plugins directory should be the same as
-# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted
+# before the help appears.
 
 GENERATE_ECLIPSEHELP   = NO
@@ -998 +1008 @@
 FORMULA_FONTSIZE       = 10
 
-# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
-# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
+# for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using HTML
+# help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should
 # typically be disabled. For large projects the javascript based search engine
 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
@@ -1005 +1018 @@
 SEARCHENGINE           = YES
 
-# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
-# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 
+# implemented using a PHP enabled web server instead of at the web client using
+# Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server based approach is 
+# that it scales better to large projects and allows full text search. The 
+# disadvances is that it is more difficult to setup
 # and does not have live searching capabilities.
 
@@ -1090 +1107 @@
 LATEX_HIDE_INDICES     = NO
 
-# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code 
+# with syntax highlighting in the LaTeX output. Note that which sources are
+# shown also depends on other settings such as SOURCE_BROWSER.
 
 LATEX_SOURCE_CODE      = NO
@@ -1338 +1357 @@
 # a tag file that is based on the input files it reads.
 
-GENERATE_TAGFILE       =
+GENERATE_TAGFILE       = doc/regfi/regfi.tags
 
 # If the ALLEXTERNALS tag is set to YES all external classes will be listed

trunk/python/pyregfi/__init__.py

@@ -1 +1 @@
 #!/usr/bin/env python
+
+## @package pyregfi
+# Python interface to the regfi library.
+#
 
 import sys
@@ -106 +110 @@
 
 
-
-regfi.regfi_get_value
-
 regfi.regfi_init.argtypes = []
 regfi.regfi_init.restype = None
@@ -114 +115 @@
 
 
+## Retrieves messages produced by regfi during parsing and interpretation
+#
 def GetLogMessages():
     msgs = regfi.regfi_log_get_str()
@@ -142 +145 @@
 
     return ret_val
-                
-
+
+
+## Abstract class which Handles memory management and proxies attribute
+#  access to base structures  
 class _StructureWrapper():
-    "Handles memory management and proxies attribute access to base structures"
+
     hive = None
     base = None
@@ -166 +171 @@
         return (not self.__eq__(other))
 
-
+## Registry key 
 class Key(_StructureWrapper):
     pass
@@ -173 +178 @@
     pass
 
+## Registry value data
 class Data(_StructureWrapper):
     pass
 
+## Registry security record/permissions
 class Security(_StructureWrapper):
     pass
@@ -277 +284 @@
 
 
+## Registry value (metadata)
+#
+# These represent registry values (@ref REGFI_VK records) and provide
+# access to their associated data.
+# 
 class Value(_StructureWrapper):
     def __getattr__(self, name):
@@ -343 +355 @@
 
 
-class Hive():    
+## Represents a single registry hive (file)
+#
+class Hive():
     file = None
     raw_file = None
@@ -366 +380 @@
         return getattr(self.file.contents, name)
     
-    def __del__(self):    
+    def __del__(self):
         regfi.regfi_free(self.file)
         if self.raw_file != None:
@@ -375 +389 @@
         return HiveIterator(self)
 
+    ## Creates a @ref HiveIterator initialized at the specified path in
+    #  the hive. 
+    #
+    # Raises an Exception if the path could not be found/traversed.
     def subtree(self, path):
         hi = HiveIterator(self)
@@ -381 +399 @@
 
 
+## A special purpose iterator for registry hives
+#
+# Iterating over an object of this type causes all keys in a specific
+# hive subtree to be returned in a depth-first manner. These iterators
+# are typically created using the @ref Hive.subtree() function on a @ref Hive
+# object.
+#
+# HiveIterators can also be used to manually traverse up and down a
+# registry hive as they retain information about the current position in
+# the hive, along with which iteration state for subkeys and values for
+# every parent key.  See the @ref up and @ref down methods for more
+# information.
 class HiveIterator():
     hive = None
@@ -419 +449 @@
                 raise StopIteration('')
             
+            # XXX: Use non-generic exception
             if not regfi.regfi_iterator_down(self.iter):
                 raise Exception('Error traversing iterator downward.'+
@@ -439 +470 @@
         apath = (c_char_p*len(path))(*cpath)
 
+        # XXX: Use non-generic exception
         if not regfi.regfi_iterator_walk_path(self.iter,apath):
             raise Exception('Could not locate path.\n'+GetLogMessages())
@@ -444 +476 @@
     def current_key(self):
         return Key(self.hive, regfi.regfi_iterator_cur_key(self.iter))
+
+    #XXX Add subkey/value search accessor functions (?)