Changeset 12009

Timestamp:

01/11/08 19:15:42 (6 months ago)

Author:

jburke

Message:

Refs #4573: putting in scope changes. Say hello to _scopeName for string IDs. \!strict

Location:

util/trunk/buildscripts

Files:

• build.js (modified) (3 diffs)
• jslib/buildUtil.js (modified) (5 diffs)
• jslib/buildUtilXd.js (modified) (7 diffs)
• jslib/dojoGuardEnd.jsfrag (modified) (1 diff)
• jslib/dojoGuardStart.jsfrag (modified) (1 diff)

util/trunk/buildscripts/build.js

@@ -131 +131 @@
                 nlsIgnoreString += (nlsIgnoreString ? "|" : "") + buildUtil.regExpEscape(nameSegment);
                 
+                
+                //Burn in scope names for dojo.js/xd.js if requested.
+                if(kwArgs.scopeMap && (layerName.match(/dojo\.xd\.js$/) || layerName.match(/dojo\.js$/))){
+                        fileContents = buildUtil.setScopeNames(fileContents, kwArgs.scopeMap);
+                }
+
                 //Burn in xd path for dojo if requested, and only do this in dojo.xd.js.
                 if(layerName.match(/dojo\.xd\.js/) && kwArgs.xdDojoPath){
@@ -143 +149 @@
                 var uncompressedContents = layerLegalText + fileContents;
                 if(layerName.match(/\.xd\.js$/) && !layerName.match(/dojo(\.xd)?\.js/)){
-                        uncompressedContents = buildUtilXd.makeXdContents(uncompressedContents, prefixes);
+                        uncompressedContents = buildUtilXd.makeXdContents(uncompressedContents, prefixes, kwArgs);
                 }
                 fileUtil.saveUtf8File(uncompressedFileName, uncompressedContents);
@@ -246 +252 @@
 
         if(kwArgs.loader == "xdomain"){
-                buildUtilXd.xdgen(prefixName, prefixPath, prefixes, layerIgnoreRegExp);
+                buildUtilXd.xdgen(prefixName, prefixPath, prefixes, layerIgnoreRegExp, kwArgs);
         }
 

util/trunk/buildscripts/jslib/buildUtil.js

@@ -92 +92 @@
                         + "will be generated in each module prefix's release directory which maps the "
                         + "short symbol names to more descriptive names."
-        }
+        },
+        "scopeMap": {
+                defaultValue: "",
+                helpText: "Change the default dojo, dijit and dojox scope names to soemthing else. Useful if you want to "
+                        + "use Dojo as part of a JS library, but want to make a self-contained library with no external dojo/dijit/dojox "
+                        + "references. Format is a string that contains no spaces, and is similar to the djConfig.scopeMap value (note that the "
+                        + "backslashes below are required to avoid shell escaping):\n"
+                        + "scopeMap: [[\\\"dojo\\\",\\\"mydojo\\\"],[\\\"dijit\\\",\\\"mydijit\\\"][\\\"dojox\\\",\\\"mydojox\\\"]]"
+        },
+        "xdScopeArgs": {
+                defaultValue: "",
+                helpText: "If the loader=xdomain build option is used, then the value of this option "
+                        + "will be used as the arguments to the function that defines the modules in the .xd.js files. "
+                        + "This allows for more than one version of the same module to be in a page. See documentation on "
+                        + "djConfig.scopeMap for more information."
+        },
+        "xdDojoScopeName": {
+                defaultValue: "dojo",
+                helpText: "If the loader=xdomain build option is used, then the value of this option "
+                        + "will be used instead of 'dojo' for the 'dojo._xdResourceLoaded()' calls that are done in the .xd.js files. "
+                        + "This allows for dojo to be under a different scope name but still allow xdomain loading with that scope name."
+        }    
 };
 
@@ -183 +204 @@
                 dojo._loadedUrls.push(buildscriptsPath + "../../dojo/_base/_loader/hostenv_"+hostenvType+".js");
         }
-
-        dojo._loadedUrls.push(buildscriptsPath + "jslib/dojoGuardEnd.jsfrag");
 }
 
@@ -372 +391 @@
                         }
                 
-                
+                        
+                        //Add the loader files if this is a loader layer.
                         if(layerName == "dojo.js"){
                                 buildUtil.includeLoaderFiles("default", hostenvType, buildscriptsPath);
@@ -398 +418 @@
                         var depList = buildUtil.determineUriList(layer.dependencies, layerUris, dependencies["filters"]); 
                         
+                        
+                        //Add the final closure guard to the list.
+                        if(layerName == "dojo.js" || layerName == "dojo.xd.js"){
+                                depList.push(buildscriptsPath + "jslib/dojoGuardEnd.jsfrag");
+                        }
+
                         //Store the layer URIs that are in this file as well as all files it depends on.
                         namedLayerUris[layer.name] = layerUris.concat(depList);
@@ -1212 +1238 @@
 }
 
+buildUtil.setScopeNames = function(/*String*/fileContents, /*String*/scopeMap){
+        //summary: burns in the scope names into the file contents.
+        //scopeMap should be a [["name","value"],["name","value"]] string. Notice the lack of spaces.
+        //Single quotes can be used instead of double quotes.
+        return fileContents.replace(/var\s+sMap\s+=\s+null/, "var sMap = " + scopeMap);
+}
+
 buildUtil.symctr = 0;
 buildUtil.symtbl = null;

util/trunk/buildscripts/jslib/buildUtilXd.js

@@ -44 +44 @@
         /*String*/prefixPath,
         /*Array*/prefixes,
-        /*RegExp*/optimizeIgnoreRegExp
+        /*RegExp*/optimizeIgnoreRegExp,
+        /*Object*/kwArgs
 ){
         //summary: generates the .xd.js files for a build.
@@ -66 +67 @@
                         //need to have special xd contents.
                         if(jsFileName.match(/\/nls\//) && fileContents.indexOf("dojo.provide(") == -1){
-                                var xdContents = buildUtilXd.makeXdBundleContents(prefixName, prefixPath, jsFileName, fileContents, prefixes);                  
+                                var xdContents = buildUtilXd.makeXdBundleContents(prefixName, prefixPath, jsFileName, fileContents, prefixes, kwArgs);                  
                         }else{
-                                xdContents = buildUtilXd.makeXdContents(fileContents, prefixes);
+                                xdContents = buildUtilXd.makeXdContents(fileContents, prefixes, kwArgs);
                         }
                         fileUtil.saveUtf8File(xdFileName, xdContents);
@@ -77 +78 @@
 //START makeXdContents function
 //Function that generates the XD version of the module file's contents
-buildUtilXd.makeXdContents = function(fileContents, prefixes){
+buildUtilXd.makeXdContents = function(fileContents, prefixes, kwArgs){
         var dependencies = [];
 
@@ -115 +116 @@
         //Build the xd file contents.
         var xdContentsBuffer = [];
-        xdContentsBuffer.push("dojo._xdResourceLoaded({\n");
+        xdContentsBuffer.push((kwArgs.xdDojoScopeName || "dojo") + "._xdResourceLoaded({\n");
         
         //Add in dependencies section.
@@ -130 +131 @@
         
         //Add the contents of the file inside a function.
-        //Pass in dojo as an argument to the function to help with
-        //allowing multiple versions of dojo in a page.
-        xdContentsBuffer.push("\ndefineResource: function(dojo){");
+        //Pass in module names to allow for multiple versions of modules in a page.
+        var scopeArgs = kwArgs.xdScopeArgs || "dojo, dijit, dojox";
+        xdContentsBuffer.push("\ndefineResource: function(" + scopeArgs + "){");
         //Remove requireLocalization calls, since that will mess things up.
         //String() part is needed since fileContents is a Java object.
@@ -144 +145 @@
 
 //START makeXdBundleContents function
-buildUtilXd.makeXdBundleContents = function(prefix, prefixPath, srcFileName, fileContents, prefixes){
+buildUtilXd.makeXdBundleContents = function(prefix, prefixPath, srcFileName, fileContents, prefixes, kwArgs){
         //logger.info("Flattening bundle: " + srcFileName);
 
@@ -169 +170 @@
 
         //Now make a proper xd.js file out of the content.
-        return buildUtilXd.makeXdContents(fileContents, prefixes);
+        return buildUtilXd.makeXdContents(fileContents, prefixes, kwArgs);
 }
 //END makeXdBundleContents function

util/trunk/buildscripts/jslib/dojoGuardEnd.jsfrag

@@ -1 @@
-};
+
+})();

util/trunk/buildscripts/jslib/dojoGuardStart.jsfrag

@@ -1 @@
-if(typeof dojo == "undefined"){
+;(function(){
+
+        /*
+        dojo, dijit, and dojox must always be the first three, and in that order.
+        djConfig.scopeMap = [
+                ["dojo", "fojo"],
+                ["dijit", "fijit"],
+                ["dojox", "fojox"]
+        
+        ]
+        */
+
+        //The null below can be relaced by a build-time value.
+        var sMap = null;
+        
+        //See if new scopes need to be defined.
+        if((sMap || (typeof djConfig != "undefined" && djConfig.scopeMap)) && (typeof window != "undefined")){
+                var scopeDef = "", scopePrefix = "", scopeSuffix = "", scopeMap = {}, scopeMapRev = {};
+                sMap = sMap || djConfig.scopeMap;
+                for(var i = 0; i < sMap.length; i++){
+                        //Make local variables, then global variables that use the locals.
+                        var newScope = sMap[i];
+                        scopeDef += "var " + newScope[0] + " = {}; " + newScope[1] + " = " + newScope[0] + ";" + newScope[1] + "._scopeName = '" + newScope[1] + "';";
+                        scopePrefix += (i == 0 ? "" : ",") + newScope[0];
+                        scopeSuffix += (i == 0 ? "" : ",") + newScope[1];
+                        scopeMap[newScope[0]] = newScope[1];
+                        scopeMapRev[newScope[1]] = newScope[0];
+                }
+
+                eval(scopeDef + "dojo._scopeArgs = [" + scopeSuffix + "];");
+
+                dojo._scopePrefixArgs = scopePrefix;
+                dojo._scopePrefix = "(function(" + scopePrefix + "){";
+                dojo._scopeSuffix = "})(" + scopeSuffix + ")";
+                dojo._scopeMap = scopeMap;
+                dojo._scopeMapRev = scopeMapRev;
+        }