[dojo] added support for dojo/dijit aliases (e.g. scopeMap)

http://code.google.com/p/fbug/source/detail?r=12681
patricioreyna · Jan 14, 2012 · 273aa25 · 273aa25
1 parent d8cf7eb
commit 273aa25
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 4 deletions.
diff --git a/dojofirebugextension/content/dojo/core/dojoaccess.js b/dojofirebugextension/content/dojo/core/dojoaccess.js
@@ -25,14 +25,28 @@ define([
 
     var DojoAccess = {};
 
+    var _getAlias = function(name) {
+        var alias = name;
+        var aliases = DojoPrefs.getAliases();
+
+        if(aliases) {
+            alias = aliases[name] || name;
+        }
+        return alias;
+    };
+
     //FIXME: This way of access objects is unsecure. Decouple communication with page and implement a secure mechanism.
     var _dojo = DojoAccess._dojo = function(context) {
         //UNSECURE
         if(!context.window) {
             return null;
         }
+        var alias=_getAlias('dojo');
+        if(FBTrace.DBG_DOJO_ALIASES) {
+            FBTrace.sysout("DOJO ALIAS for dojo: "+alias);
+        }
 
-        return Wrapper.unwrapObject(context.window).dojo || null;        
+        return Wrapper.unwrapObject(context.window)[alias] || null;        
     };
 
     //FIXME: This way of access objects is unsecure. Decouple communication with page and implement a secure mechanism.
@@ -41,8 +55,12 @@ define([
         if(!context.window) {
             return null;
         }
+        var alias=_getAlias('dijit');
+        if(FBTrace.DBG_DOJO_ALIASES) {
+            FBTrace.sysout("DOJO ALIAS for dijit: "+alias);
+        }
 
-        return Wrapper.unwrapObject(context.window).dijit || null;        
+        return Wrapper.unwrapObject(context.window)[alias] || null;        
     };
 
 

diff --git a/dojofirebugextension/content/dojo/core/prefs.js b/dojofirebugextension/content/dojo/core/prefs.js
@@ -25,7 +25,7 @@ define([
     var documentation_API_DOC_URL_BASE = "dojofirebugextension.documentation.API_DOC_URL_BASE";
     var documentation_DOC_SORTED_VERSIONS = "dojofirebugextension.documentation.DOC_SORTED_VERSIONS";
 
-
+    
     var isExtensionEnabled = DojoPrefs.isExtensionEnabled = function() {
         return Firebug.Options.getPref("extensions.firebug.dojofirebugextension", "enableSites");
     };
@@ -104,6 +104,32 @@ define([
     var getApiDocURL = DojoPrefs.getApiDocURL = function() {
         return Firebug.Options.getPref(Firebug.Options.getPrefDomain(), documentation_API_DOC_URL_BASE);
     };
+
+    //DOJO ALIASES (ie. scopeMap)
+    var aliasCacheStr, aliasCache;
+    DojoPrefs.getAliases = function() {
+        var value = Firebug.Options.getPref("extensions.firebug.dojofirebugextension", "aliases");
+        if(!value) {
+            return;
+        }
+        if(aliasCacheStr == value) {
+            if(FBTrace.DBG_DOJO_ALIASES) {
+                FBTrace.sysout("DOJO ALIASES - returning cached value: ", [value, aliasCacheStr, aliasCache]);   
+            }
+            return aliasCache;
+        }
+        aliasCacheStr = value;
+        try {
+            aliasCache = JSON.parse(value);
+            return aliasCache;
+        } catch(err) {
+            if(FBTrace.DBG_DOJO_ALIASES) {
+                FBTrace.sysout("DOJO ALIASES ERROR: value="+value, err);
+            }
+            return;
+        }
+    };
+
 
     // ***************************************************************
 

diff --git a/dojofirebugextension/defaults/preferences/prefs.js b/dojofirebugextension/defaults/preferences/prefs.js
@@ -18,9 +18,13 @@ pref("extensions.firebug.DBG_DOJO_CONN_COUNTER", false);
 pref("extensions.firebug.DBG_DOJO_DBG_DOC", false);
 pref("extensions.firebug.DBG_DOJO_CONTEXTMENU", false);
 pref("extensions.firebug.DBG_DOJO_DBG_VERSIONS", false);
+pref("extensions.firebug.DBG_DOJO_ALIASES", false);
 
 //Dojo documentation related preferences
 pref("extensions.firebug.dojofirebugextension.documentation.REFERENCE_GUIDE_URL", "http://dojotoolkit.org/reference-guide/");
 pref("extensions.firebug.dojofirebugextension.documentation.API_DOC_URL_BASE", "http://dojotoolkit.org/api/");
 //DOC_SORTED_VERSIONS contains the available documentation version numbers in the http://dojotoolkit.org/api/ page
-pref("extensions.firebug.dojofirebugextension.documentation.DOC_SORTED_VERSIONS", "1.3,1.4,1.5,1.6,1.7");
+pref("extensions.firebug.dojofirebugextension.documentation.DOC_SORTED_VERSIONS", "1.3,1.4,1.5,1.6,1.7");
+
+//aliases (eg. \"{'dojo':'myDojo', 'dijit': 'myDijit', 'dojox': 'myDojox'}\" )
+pref("extensions.firebug.dojofirebugextension.aliases", "");