Note: this commit includes new functionality to save and restore scripts configure options. This is ongoing work, scripts still have to be updated to use this feature and more tests are needed, though many have been performed. The new Scripts Config Editor script is the main part of this. If anyone wants to check it, only the AC3D importer and exporter have already been updated to use it: simply open them (you can then cancel with ESC) to have the data created, then try the config editor.

Scripts:
- Thanks Jean-Michel Soler (jms) for updated versions of dispaint, fixfromarmature and unweld (also renamed to remove version part).
- Thanks Bart for the upgraded VRML exporter (great doc webpage!).  It is available as VRML 97 and the original VRML 2 is for now still there, to help users testing the new version.  For the next release the old one should be removed, of course.
- New script: Scripts Config Editor (Scripts win -> Scripts -> System).  Scripts with config options (simple data that is to be set according to user needs or preferences) can use this facility instead of providing a gui and writing config files to disk themselves.
- Added new menu: System, available in the Scripts win.
- Updated sys_info.py, help_browse.py and the AC3D importer and exporter.
- Removed use of the Scrollbar and added arrow keys and mouse wheel support instead in Daniel Dunbar's old doc_browser.py. The scrollbar events handling doesn't exist, Ton suggested removing the scrollbar from the API months ago.  For now its ref doc is gone and no bundled script uses it, until we get time to implement it properly.
- Added module BPyRegistry.py with functions to handle reading / writing config files automatically to the scripts/bpydata/config dir.
- Removing dir release/bpydata and its contents (moved earlier to release/scripts/bpydata/)
- Bug #2379: made small changes to bevel_center's ui to fix a problem reported by Alexander Ewering (intrr):
http://projects.blender.org/tracker/?func=detail&atid=125&aid=2379&group_id=9

BPython:
- Thanks Campbell Barton for new functionality: Blender.Get() now can also return all the paths from the user prefs -> file paths win and there is a new function: Blender.sys.expandpath() to transform Blender paths (those starting with '//' and ending with '#') to absolute paths.
- Added function Blender.ShowHelp(), to open the Scripts Help Browser with a given help page -- just a time saver for scripts.
- Improved function Blender.Run() to also work with gui and file select scripts.
- Found a (new?) crash related to NMesh.PutRaw when creating a new object while in edit mode.  Leaving / entering edit mode fixes the problem, so a check for obj created, edit mode and leaving / re-entering it were added to the code for now (gdb didn't help much, no backtrace)
- doc updates, including splitting intro page in two, with bpython related stuff (registering / documenting / configuring scripts and command line mode (thanks Chris Want for "use system variables to pass parameters to scripts" idea).
- Registry: functions have been updated to support writing to / reading from disk, for the config editor -- only simple config data supported, for large amounts coders should write to a file themselves.  This is done with a new parameter: Registry.GetKey(keyname, True) will also search for the key on the config dir, if not already loaded; equiv. for Registry.SetKey(keyname, dict, True).  Data is only written to / read from disk when needed and only scripts already used (assuming they support this functionality) will have config data saved.

1 files changed, 30 insertions, 19 deletions

diff --git a/source/blender/python/api2_2x/doc/Registry.py b/source/blender/python/api2_2x/doc/Registry.py
index 390669eb37d..5913505f4e4 100644
--- a/source/blender/python/api2_2x/doc/Registry.py
+++ b/source/blender/python/api2_2x/doc/Registry.py
@@ -3,6 +3,8 @@
 """
 The Blender.Registry submodule.
 
+B{New}: L{GetKey} and L{SetKey} can respectively load and save data to disk now.
+
 Registry
 ========
 
@@ -17,19 +19,19 @@ give script authors a way around this limitation.
 In Python terms, the Registry holds a dictionary of dictionaries.
 You should use it to save Python objects only, not BPython (Blender Python)
 objects -- but you can save BPython object names, since those are strings.
-Also, if you need to save a considerable amount of data, please save to a
-file instead. There's no need to keep huge blocks of memory around when they
-can simply be read from a file.
+Also, if you need to save a considerable amount of data, we recommend saving
+it to a file instead. There's no need to keep huge blocks of memory around when
+they can simply be read from a file.
+
+Examples of what this module can be used for:
 
-Two uses for this module:
+a) Saving data from a script that another script will need to access later.
 
-a) To save data from a script that another script will need to access later.
+b) Saving configuration data for a script.  Users can view and edit this data
+using the "Scripts Configuration Editor" script, then.
 
-b) To save configuration data from your script's gui (button values) so that the
-next time the user runs your script, the changes will still be there. Later we
-can make Blender save the Registry so that its data won't be lost after users
-quit the program. And also add an option to save as a Text that can be kept in
-a .blend file, letting users keep script data there.
+c) Saving configuration data from your script's gui (button values) so that the
+next time the user runs your script, the changes will still be there.  
 
 Example::
 
@@ -42,12 +44,12 @@ Example::
   mystr = "hello"
 
   # then check if they are already at the Registry (saved on a
-  # previous execution of this script):
-  dict = Registry.GetKey('MyScript')
-  if dict: # if found, get the values saved there
-    myvar1 = dict['myvar1']
-    myvar2 = dict['myvar2']
-    mystr = dict['mystr']
+  # previous execution of this script) or on disk:
+  rdict = Registry.GetKey('MyScript', True)
+  if rdict: # if found, get the values saved there
+    myvar1 = rdict['myvar1']
+    myvar2 = rdict['myvar2']
+    mystr = rdict['mystr']
 
   # let's create a function to update the Registry when we need to:
   def update_Registry():
@@ -55,7 +57,8 @@ Example::
     d['myvar1'] = myvar1
     d['myvar2'] = myvar2
     d['mystr'] = mystr
-    Blender.Registry.SetKey('MyScript', d)
+    # cache = True: data is also saved to a file
+    Blender.Registry.SetKey('MyScript', d, True)
 
   # ...
   # here goes the main part of the script ...
@@ -72,21 +75,29 @@ def Keys ():
   Get all keys currently in the Registry's dictionary.
   """
 
-def GetKey (key):
+def GetKey (key, cached = False):
   """
   Get key 'key' from the Registry.
   @type key: string
   @param key: a key from the Registry dictionary.
+  @type cached: bool
+  @param cached: if True and the requested key isn't already loaded in the
+      Registry, it will also be searched on the user or default scripts config
+      data dir (config subdir in L{Blender.Get}('datadir')).
   @return: the dictionary called 'key'.
   """
 
-def SetKey (key, dict):
+def SetKey (key, dict, cache = False):
   """
   Store a new entry in the Registry.
   @type key: string
   @param key: the name of the new entry, tipically your script's name.
   @type dict: dictionary
   @param dict: a dict with all data you want to save in the Registry.
+  @type cache: bool
+  @param cache: if True the given key data will also be saved as a file
+      in the config subdir of the scripts user or default data dir (see
+      L{Blender.Get}.
   """
 
 def RemoveKey (key):