MMIR Framework

Source: tools/codeGenUtils.js

  2. /**
  3.  * Utilities for handling generated code (e.g. grammars, views etc.)
  4.  *
  5.  * @name CodeGenUtils
  6.  * @class
  7.  * @memberOf mmir.tools
  8.  * @static
  9.  * @hideconstructor
  10.  *
  11.  * @example
  12.  *  var codeGenUtils = mmir.require('mmirf/codeGenUtils');
  13.  *  var prefixCode = codeGenUtils.getCodeWrapPrefix();
  14.  *  //...
  15.  *
  16.  */
  17. define(function(){
  18. 	return {
  19. 		/**
  20. 		 * Prefix for wrapping persisted objects:
  21. 		 *
  22. 		 * <ul>
  23. 		 *  <li> wraps code into a closure
  24. 		 *  </li><li> makes global namespace available as variable <code>global</code>
  25. 		 *  </li><li> makes mmirf/core available as variable <code>mmir</code> (if mmirf/core is present in global namespace)
  26. 		 *  </li><li> makes mmirf/core's require function available as <code>require</code> (if mmirf/core is present and has require function)
  27. 		 * </ul>
  28. 		 *
  29. 		 * @param  {Boolean} [disableStrictMode] OPTIONAL 	disable JavaScript strict mode in the generated closure
  30. 		 * 																								 (i.e. allow non-strict JS code in the generated code)
  31. 		 *
  32. 		 * @returns {String} the prefix code for closure-wrapping generated code (i.e. prepend to generated code)
  33. 		 *
  34. 		 * @see #getCodeWrapSuffix
  35. 		 *
  36. 		 * @public
  37. 		 * @function
  38. 		 * @memberOf mmir.tools.CodeGenUtils#
  39. 		 */
  40. 		getCodeWrapPrefix: function(disableStrictMode){
  42. 			return  ';(function(global){\n' +
  43. 								(disableStrictMode? '' : '"use strict";\n')+
  44. 								'var mmirName = typeof MMIR_CORE_NAME === "string"? MMIR_CORE_NAME : "mmir";\n'+
  45. 								'var mmir = global? global[mmirName] : void(0);\n'+
  46. 								'var require = mmir && mmir.require? mmir.require : (typeof requirejs !== "undefined"? requirejs : (global? global.require : require));\n';
  47. 		},
  48. 		/**
  49. 		 * Suffix for wrapping generated code in a closure:
  50. 		 *
  51. 		 * <ul>
  52. 		 *  <li> closes and self-calls closure
  53. 		 *  </li>
  54. 		 *  <li> sets global namespace to <code>window</code> (browser) or <code>self</code> (browser webworker) or <code>global</code> (node module)
  55. 		 *  		(via the closure function's argument)
  56. 		 *  </li>
  57. 		 * </ul>
  58. 		 *
  59. 		 * @returns {String} the suffix code for closure-wrapping of generated code (i.e. append to generated code)
  60. 		 *
  61. 		 * @see #getCodeWrapPrefix
  62. 		 *
  63. 		 * @public
  64. 		 * @function
  65. 		 * @memberOf mmir.tools.CodeGenUtils#
  66. 		 */
  67. 		getCodeWrapSuffix: function(){
  69. 			return '\n})(typeof window !== "undefined" ? window : typeof self !== "undefined" ? self : typeof global !== "undefined" ? global : this);\n';
  70. 		}
  71. 	}
  72. });