MMIR Framework

Source: mvc/parser/parsingResult.js

  2. /**
  3.  * Dependencies:
  4.  *
  5.  *  * parser.element (parserModule.js)
  6.  *  * OPTIONALLY: ANTLR TokenStream (antlr3-all.js)
  7.  *                (if present, the constructor may be able to automatically derive start/end properties from given argument)
  8.  *
  9.  *
  10.  * @requires antlr3-all.js as <code>org</code> (see comment above)
  11.  *
  12.  */
  14. define(['mmirf/parserModule'],
  15. //this comment is needed by jsdoc2 [copy of comment for: function ParsingResult(...]
  16. /**
  17.  * ParsingResult represents an element that was detected during parsing.
  18.  *
  19.  * <p>
  20.  * The detected element is referenced by the properties <code>start</code> and <code>end</code>
  21.  * that refer to the start-index and end-index within the parsed text.
  22.  *
  23.  * <p>
  24.  * The ParsingResult has a <code>type</code> property which refers to the kind of element
  25.  * that was detected (see constants in {@link mmir.parser.Element}).
  26.  *
  27.  * <p>
  28.  * In addition, the ParsingResult may have several properties that depend of its type. In general,
  29.  * these properties refer to detected parts of the element (e.g. for a invocation-statement, these
  30.  * may refer to its arguments).
  31.  *
  32.  *
  33.  * <p>
  34.  * Properties for <strong>INCLUDE_SCRIPT</strong> type:
  35.  * <ul>
  36.  * 	<li><strong>scriptPath</strong>: the path / URL to the resource</li>
  37.  * 	<li><strong>scriptPathType</strong>: the type of the <tt>scriptPath</tt>
  38.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  39.  * </ul>
  40.  * <p>
  41.  * Properties for <strong>INCLUDE_STYLE</strong> type:
  42.  * <ul>
  43.  * 	<li><strong>stylePath</strong>: </li>
  44.  * 	<li><strong>stylePathType</strong>: the type of the <tt>stylePath</tt>
  45.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  46.  * </ul>
  47.  * <p>
  48.  * Properties for <strong>LOCALIZE</strong> type:
  49.  * <ul>
  50.  * 	<li><strong>name</strong>: the name/identifier for the localized String</li>
  51.  * 	<li><strong>nameType</strong>: the type of the <tt>name</tt>
  52.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  53.  * </ul>
  54.  * <p>
  55.  * Properties for <strong>YIELD_DECLARATION</strong> type:
  56.  * <ul>
  57.  * 	<li><strong>name</strong>: the name/identifier for the yield section</li>
  58.  * 	<li><strong>nameType</strong>: the type of the <tt>name</tt>
  59.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  60.  * </ul>
  61.  * Properties for <strong>BLOCK</strong> type:
  62.  * <ul>
  63.  * 	<li><strong>scriptContent</strong> {String}: <tt>OPTIONALLY</tt> the script code as a String</li>
  64.  * 	<li><strong>scriptEval</strong> {Function}: the compiled script code in form of a function. The
  65.  * 							function takes one argument: the current data-object.</li>
  66.  * </ul>
  67.  * <p>
  68.  * Properties for <strong>STATEMENT</strong> type:
  69.  * <ul>
  70.  * 	<li><strong>scriptContent</strong> {String}: <tt>OPTIONALLY</tt> the script code as a String</li>
  71.  * 	<li><strong>scriptEval</strong> {Function}: the compiled script code in form of a function. The
  72.  * 							function takes one argument: the current data-object.</li>
  73.  * </ul>
  74.  * <p>
  75.  * Properties for <strong>HELPER</strong> type:
  76.  * <ul>
  77.  * 	<li><strong>helper</strong>: the name of the helper function</li>
  78.  * 	<li><strong>helperType</strong>: the type of the <tt>helper</tt>
  79.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  80.  * 	<li><strong>argsEval</strong> {Function}: OPTIONALLY compiled getter Function for retrieving the current ARGS
  81.  * 			(optional argument) of the helper expression. The function takes one argument: the current data-object.</li>
  82.  * </ul>
  83.  * <p>
  84.  * Properties for <strong>IF</strong> type:
  85.  * <ul>
  86.  * 	<li><strong>ifEval</strong> {Function}: the condition statement, that was compiled into a Function. The
  87.  * 							function takes one argument: the current data-object.</li>
  88.  * 	<li><strong>content</strong> {ContentElement}: the HTML / template content that should be render, in case the
  89.  * 					if-expression evaluates to <code>true</code>.</li>
  90.  *  <li><strong>elseContent</strong> {@link mmir.parser.ParsingResult}: OPTIONALLY a ParsingResult
  91.  *  					representing an else-expression, see {@link mmir.parser.Element.ELSE}.</li>
  92.  * </ul>
  93.  * <p>
  94.  * Properties for <strong>ELSE</strong> type:
  95.  * <ul>
  96.  * 	<li><strong>content</strong> {ContentElement}: the HTML / template content that should be render, in case the
  97.  * 					if-expression (to which the else-expression belongs) evaluates to <code>false</code>.</li>
  98.  * </ul>
  99.  * <p>
  100.  * Properties for <strong>FOR</strong> type:
  101.  * <ul>
  102.  * 	<li><strong>forControlType</strong> {String}: the type of for-loop, either <code>FORITER</code> or <code>FORSTEP</code></li>
  103.  * 	<li><strong>forInitEval</strong> {Function}: the initialization statement of the for-expression, compiled into
  104.  * 									a Function. The function takes one argument: the current data-object.</li>
  105.  *
  106.  * 	<li><code>FORITER</code>: <code>@for(PROP in OBJ){ ... }@</code>
  107.  * 	 <ul>
  108.  * 		<li><strong>forIterator</strong> {Object}: an iterator object with functions <code>hasNext() : Boolean</code> and
  109.  * 					<code>next() : String</code> (which returns the name of the property currently iterated).</li>
  110.  * 		<li><strong>forPropName</strong> {String}: the variable name for the property which is currently iterated over.</li>
  111.  * 	 </ul>
  112.  * 	</li>
  113.  * 	<li><code>FORSTEP</code>: <code>@for(INIT; CONDITION; INCREMENT){ ... }@</code>
  114.  * 	 <ul>
  115.  * 		<li><strong>forConditionEval</strong> {Function}: the condition statement of the for-expression, compiled into
  116.  * 											a Function. The function takes one argument: the current data-object.</li>
  117.  * 		<li><strong>forIncrementEval</strong> {Function}: the increment statement of the for-expression, compiled into
  118.  * 											a Function. The function takes one argument: the current data-object.</li>
  119.  * 	 </ul>
  120.  * 	</li>
  121.  * 	<li><strong>content</strong> {ContentElement}: the HTML / template content that should be rendered
  122.  * 								 during each iteration of the for-loop.</li>
  123.  * </ul>
  124.  * <p>
  125.  * Properties for <strong>RENDER</strong> type:
  126.  * <ul>
  127.  * 	<li><strong>partial</strong>: the name of the partial view</li>
  128.  * 	<li><strong>partialType</strong>: the type of the <tt>partial</tt>
  129.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  130.  * 	<li><strong>controller</strong>: the name of the controller, to which the partial view definition belongs</li>
  131.  * 	<li><strong>controllerType</strong>: the type of the <tt>controller</tt>
  132.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  133.  * 	<li><strong>argsEval</strong> {Function}: OPTIONALLY compiled getter Function for retrieving the current ARGS
  134.  * 								(optional argument) of the render expression. The function takes one argument: the current data-object.</li>
  135.  * </ul>
  136.  * <p>
  137.  * Properties for <strong>ESCAPE_ENTER</strong> type:
  138.  * <ul>
  139.  * 	<li><strong>text</strong> {String}: the text that will be rendered (i.e. without the escape-character(s) itself).</li>
  140.  * </ul>
  141.  * <p>
  142.  * Properties for <strong>ESCAPE_EXIT</strong> type:
  143.  * <ul>
  144.  * 	<li><strong>text</strong> {String}: the text that will be rendered (i.e. without the escape-character(s) itself).</li>
  145.  * </ul>
  146.  * <p>
  147.  * Properties for <strong>VAR_DECLARATION</strong> type:
  148.  * <ul>
  149.  * 	<li><strong>name</strong>: the name for the variable (without the leading <tt>@</tt> of template variables)</li>
  150.  * 	<li><strong>nameType</strong>: the type of the <tt>name</tt> field: <code>StringLiteral</code></li>
  151.  * </ul>
  152.  *
  153.  * <p>
  154.  *
  155.  * @param {org.antlr.runtime.CommonTokenStream|org.antlr.runtime.Token} [thetokens] OPTIONAL
  156.  * 					if <code>org.antlr.runtime.CommonTokenStream</code>:
  157.  * 												the TokenStream that corresponds to this parsed element;
  158.  * 												when provided, the TokenStream is used to set the start- and end-
  159.  * 												property of the new instance.<br>
  160.  * 		  			if <code>org.antlr.runtime.Token</code>:
  161.  * 												if the parameter is a single Token object, then the start- and end-
  162.  * 												property for the new instance is set by this token object
  163.  * @class
  164.  * @constructor
  165.  * @name ParsingResult
  166.  * @memberOf mmir.parser
  167.  */
  168. function(parser){
  170. var _antrl3;
  172. //set to @ignore in order to avoid doc-duplication in jsdoc3
  173. /**
  174.  * ParsingResult represents an element that was detected during parsing.
  175.  *
  176.  * <p>
  177.  * The detected element is referenced by the properties <code>start</code> and <code>end</code>
  178.  * that refer to the start-index and end-index within the parsed text.
  179.  *
  180.  * <p>
  181.  * The ParsingResult has a <code>type</code> property which refers to the kind of element
  182.  * that was detected (see constants in {@link mmir.parser.Element}).
  183.  *
  184.  * <p>
  185.  * In addition, the ParsingResult may have several properties that depend of its type. In general,
  186.  * these properties refer to detected parts of the element (e.g. for a invocation-statement, these
  187.  * may refer to its arguments).
  188.  *
  189.  *
  190.  * <p>
  191.  * Properties for <strong>INCLUDE_SCRIPT</strong> type:
  192.  * <ul>
  193.  * 	<li><strong>scriptPath</strong>: the path / URL to the resource</li>
  194.  * 	<li><strong>scriptPathType</strong>: the type of the <tt>scriptPath</tt>
  195.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  196.  * </ul>
  197.  * <p>
  198.  * Properties for <strong>INCLUDE_STYLE</strong> type:
  199.  * <ul>
  200.  * 	<li><strong>stylePath</strong>: </li>
  201.  * 	<li><strong>stylePathType</strong>: the type of the <tt>stylePath</tt>
  202.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  203.  * </ul>
  204.  * <p>
  205.  * Properties for <strong>LOCALIZE</strong> type:
  206.  * <ul>
  207.  * 	<li><strong>name</strong>: the name/identifier for the localized String</li>
  208.  * 	<li><strong>nameType</strong>: the type of the <tt>name</tt>
  209.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  210.  * </ul>
  211.  * <p>
  212.  * Properties for <strong>YIELD_DECLARATION</strong> type:
  213.  * <ul>
  214.  * 	<li><strong>name</strong>: the name/identifier for the yield section</li>
  215.  * 	<li><strong>nameType</strong>: the type of the <tt>name</tt>
  216.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  217.  * </ul>
  218.  * Properties for <strong>BLOCK</strong> type:
  219.  * <ul>
  220.  * 	<li><strong>scriptContent</strong> {String}: <tt>OPTIONALLY</tt> the script code as a String</li>
  221.  * 	<li><strong>scriptEval</strong> {Function}: the compiled script code in form of a function. The
  222.  * 							function takes one argument: the current data-object.</li>
  223.  * </ul>
  224.  * <p>
  225.  * Properties for <strong>STATEMENT</strong> type:
  226.  * <ul>
  227.  * 	<li><strong>scriptContent</strong> {String}: <tt>OPTIONALLY</tt> the script code as a String</li>
  228.  * 	<li><strong>scriptEval</strong> {Function}: the compiled script code in form of a function. The
  229.  * 							function takes one argument: the current data-object.</li>
  230.  * </ul>
  231.  * <p>
  232.  * Properties for <strong>HELPER</strong> type:
  233.  * <ul>
  234.  * 	<li><strong>helper</strong>: the name of the helper function</li>
  235.  * 	<li><strong>helperType</strong>: the type of the <tt>helper</tt>
  236.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  237.  * 	<li><strong>argsEval</strong> {Function}: OPTIONALLY compiled getter Function for retrieving the current ARGS
  238.  * 			(optional argument) of the helper expression. The function takes one argument: the current data-object.</li>
  239.  * </ul>
  240.  * <p>
  241.  * Properties for <strong>IF</strong> type:
  242.  * <ul>
  243.  * 	<li><strong>ifEval</strong> {Function}: the condition statement, that was compiled into a Function. The
  244.  * 							function takes one argument: the current data-object.</li>
  245.  * 	<li><strong>content</strong> {ContentElement}: the HTML / template content that should be render, in case the
  246.  * 					if-expression evaluates to <code>true</code>.</li>
  247.  *  <li><strong>elseContent</strong> {@link mmir.parser.ParsingResult}: OPTIONALLY a ParsingResult
  248.  *  					representing an else-expression, see {@link mmir.parser.Element.ELSE}.</li>
  249.  * </ul>
  250.  * <p>
  251.  * Properties for <strong>ELSE</strong> type:
  252.  * <ul>
  253.  * 	<li><strong>content</strong> {ContentElement}: the HTML / template content that should be render, in case the
  254.  * 					if-expression (to which the else-expression belongs) evaluates to <code>false</code>.</li>
  255.  * </ul>
  256.  * <p>
  257.  * Properties for <strong>FOR</strong> type:
  258.  * <ul>
  259.  * 	<li><strong>forControlType</strong> {String}: the type of for-loop, either <code>FORITER</code> or <code>FORSTEP</code></li>
  260.  * 	<li><strong>forInitEval</strong> {Function}: the initialization statement of the for-expression, compiled into
  261.  * 									a Function. The function takes one argument: the current data-object.</li>
  262.  *
  263.  * 	<li><code>FORITER</code>: <code>@for(PROP in OBJ){ ... }@</code>
  264.  * 	 <ul>
  265.  * 		<li><strong>forIterator</strong> {Object}: an iterator object with functions <code>hasNext() : Boolean</code> and
  266.  * 					<code>next() : String</code> (which returns the name of the property currently iterated).</li>
  267.  * 		<li><strong>forPropName</strong> {String}: the variable name for the property which is currently iterated over.</li>
  268.  * 	 </ul>
  269.  * 	</li>
  270.  * 	<li><code>FORSTEP</code>: <code>@for(INIT; CONDITION; INCREMENT){ ... }@</code>
  271.  * 	 <ul>
  272.  * 		<li><strong>forConditionEval</strong> {Function}: the condition statement of the for-expression, compiled into
  273.  * 											a Function. The function takes one argument: the current data-object.</li>
  274.  * 		<li><strong>forIncrementEval</strong> {Function}: the increment statement of the for-expression, compiled into
  275.  * 											a Function. The function takes one argument: the current data-object.</li>
  276.  * 	 </ul>
  277.  * 	</li>
  278.  * 	<li><strong>content</strong> {ContentElement}: the HTML / template content that should be rendered
  279.  * 								 during each iteration of the for-loop.</li>
  280.  * </ul>
  281.  * <p>
  282.  * Properties for <strong>RENDER</strong> type:
  283.  * <ul>
  284.  * 	<li><strong>partial</strong>: the name of the partial view</li>
  285.  * 	<li><strong>partialType</strong>: the type of the <tt>partial</tt>
  286.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  287.  * 	<li><strong>controller</strong>: the name of the controller, to which the partial view definition belongs</li>
  288.  * 	<li><strong>controllerType</strong>: the type of the <tt>controller</tt>
  289.  * 		 field: one of <code>StringLiteral</code>, <code>Identifier</code>, <code>IdentifierNameAmpersatStart</code></li>
  290.  * 	<li><strong>argsEval</strong> {Function}: OPTIONALLY compiled getter Function for retrieving the current ARGS
  291.  * 								(optional argument) of the render expression. The function takes one argument: the current data-object.</li>
  292.  * </ul>
  293.  * <p>
  294.  * Properties for <strong>ESCAPE_ENTER</strong> type:
  295.  * <ul>
  296.  * 	<li><strong>text</strong> {String}: the text that will be rendered (i.e. without the escape-character(s) itself).</li>
  297.  * </ul>
  298.  * <p>
  299.  * Properties for <strong>ESCAPE_EXIT</strong> type:
  300.  * <ul>
  301.  * 	<li><strong>text</strong> {String}: the text that will be rendered (i.e. without the escape-character(s) itself).</li>
  302.  * </ul>
  303.  * <p>
  304.  * Properties for <strong>VAR_DECLARATION</strong> type:
  305.  * <ul>
  306.  * 	<li><strong>name</strong>: the name for the variable (without the leading <tt>@</tt> of template variables)</li>
  307.  * 	<li><strong>nameType</strong>: the type of the <tt>name</tt> field: <code>StringLiteral</code></li>
  308.  * </ul>
  309.  *
  310.  * <p>
  311.  *
  312.  * @constructs ParsingResult
  313.  * @param {org.antlr.runtime.CommonTokenStream|org.antlr.runtime.Token} [thetokens] OPTIONAL
  314.  * 					if <code>org.antlr.runtime.CommonTokenStream</code>:
  315.  * 												the TokenStream that corresponds to this parsed element;
  316.  * 												when provided, the TokenStream is used to set the start- and end-
  317.  * 												property of the new instance.<br>
  318.  * 		  			if <code>org.antlr.runtime.Token</code>:
  319.  * 												if the parameter is a single Token object, then the start- and end-
  320.  * 												property for the new instance is set by this token object
  321.  *
  322.  * @ignore
  323.  */
  324. function ParsingResult (thetokens){
  325. 	var isSet = false;
  327. 	//try to extract start-/end-indexes from the argument:
  328. 	if(thetokens){
  330. 		if(typeof org !== 'undefined'){
  331. 			//NOTE: must invoke getTokens() for initializing size() etc.!
  332. 			if(thetokens instanceof org.antlr.runtime.CommonTokenStream && thetokens.getTokens() && thetokens.size() > 0){
  333. 				this.start = thetokens.getTokens()[0].getStartIndex();
  334. 				this.end = thetokens.getTokens()[thetokens.size()-1].getStopIndex();
  336. 				isSet = true;
  337. 			}
  338. 			else if(thetokens instanceof org.antlr.runtime.CommonToken || thetokens instanceof org.antlr.runtime.Token){
  339. 				this.start = thetokens.getStartIndex();
  340. 				this.end = thetokens.getStopIndex();
  342. 				isSet = true;
  343. 			}
  344. 		}
  346. 		//if not already set, try...
  347. 		if( isSet === false && typeof thetokens.getToken !== 'undefined' && (typeof thetokens.getToken().getStartIndex !== 'undefined' && typeof thetokens.getToken().getStopIndex !== 'undefined')){
  348. 			this.start = thetokens.getToken().getStartIndex();
  349. 			this.end = thetokens.getToken().getStopIndex();
  351. 			isSet = true;
  352. 		}
  353. 		else if(typeof thetokens.getStartIndex !== 'undefined' && typeof thetokens.getStopIndex !== 'undefined'){
  354. 			this.start = thetokens.getStartIndex();
  355. 			this.end = thetokens.getStopIndex();
  357. 			isSet = true;
  358. 		}
  359. 		else if(isSet === false) {
  360. 			var type = Object.prototype.toString.call(thetokens);//.match(/^\[object (.*)\]$/)[1];
  361. 			console.warn('unknown argument type: '+type);//debug
  362. 		}
  363. 	}
  365. 	if(isSet === false) {
  366. 		this.start = -1;
  367. 		this.end   = -1;
  368. 	}
  369. };
  371. /**
  372.  * Set the start position (index) for this parsed element with regard to the TokenStream of the complete input.
  373.  *
  374.  * @function
  375.  * @param {org.antlr.runtime.CommonTokenStream} thetokens (optional) the TokenStream that corresponds to this parsed element;
  376.  * 												when provided, the TokenStream is used to set the start-property of this object.
  377.  *
  378.  * @public
  379.  * @memberOf mmir.parser.ParsingResult
  380.  */
  381. ParsingResult.prototype.setStartFrom = function(thetokens){
  382. 	//NOTE: must invoke getTokens() for initializing size() etc.!
  383. 	if(thetokens.getTokens() && thetokens.size() > 0){
  384. 		this.start = thetokens.getTokens()[0].getStartIndex();
  385. 	}
  386. 	else {
  387. 		this.start = -1;
  388. 	}
  389. };
  391. /**
  392.  * Set the end position (index) for this parsed element with regard to the TokenStream of the complete input.
  393.  *
  394.  * @function
  395.  * @param {org.antlr.runtime.CommonTokenStream} thetokens (optional) the TokenStream that corresponds to this parsed element;
  396.  * 												when provided, the TokenStream is used to set the end-property of this object.
  397.  *
  398.  * @public
  399.  * @memberOf mmir.parser.ParsingResult
  400.  */
  401. ParsingResult.prototype.setEndFrom = function(thetokens){
  402. 	//NOTE: must invoke getTokens() for initializing size() etc.!
  403. 	if(thetokens.getTokens() && thetokens.size() > 0){
  404. 		this.end = thetokens.getTokens()[thetokens.size()-1].getStopIndex();
  405. 	}
  406. 	else {
  407. 		this.end = -1;
  408. 	}
  409. };
  410. /**  @memberOf mmir.parser.ParsingResult */
  411. ParsingResult.prototype.getStart = function(){
  412. 	return this.start;
  413. };
  414. /**  @memberOf mmir.parser.ParsingResult */
  415. ParsingResult.prototype.getEnd = function(){
  416. 	return this.end;
  417. };
  419. /**
  420.  * Get the type of this parsed element, i.e. as which type this element was parsed.
  421.  *
  422.  * The type corresponds to one of the type defined in {mmir.parser.Element}.
  423.  *
  424.  * @function
  425.  * @return {mmir.parser.Element} the type for this ParsingResult
  426.  *
  427.  * @public
  428.  * @memberOf mmir.parser.ParsingResult
  429.  */
  430. ParsingResult.prototype.getType = function(){
  431. 	return this.type;
  432. };
  434. /**
  435.  * helper function for converting properties to the correct value.
  436.  * By default, the ParsingResult only contains "raw" property values.
  437.  * Which properties are available, depends on the type of the ParsingResult (see templateProcessor.js)
  438.  *
  439.  * @memberOf mmir.parser.ParsingResult
  440.  */
  441. ParsingResult.prototype.getValue = function(rawPropertyValue, proptertyType, data){
  443. 	if(proptertyType === 'StringLiteral'){
  444. 		return rawPropertyValue.substring(1, rawPropertyValue.length-1);
  445. 	}
  446. 	else if(proptertyType === 'Identifier'){
  447. 		if(data){
  448. 			return data['@' + rawPropertyValue];
  449. 		}
  450. 		else {
  451. 			//just return variable name
  452. 			return rawPropertyValue;
  453. 		}
  454. 	}
  455. 	else if(proptertyType === 'IdentifierNameAmpersatStart'){
  456. 		if(data){
  457. 			return data[rawPropertyValue];
  458. 		}
  459. 		else {
  460. 			//just return variable name, but remove leading @:
  461. 			return rawPropertyValue.substring(1);
  462. 		}
  463. 	}
  464. 	else if(proptertyType === 'OBJECT'){
  465. 		return rawPropertyValue;//TODO
  466. 	}
  467. 	else if(proptertyType === 'DecimalLiteral'){
  468. 		return parseFloat(rawPropertyValue);
  469. 	}
  470. //	else if(typeof proptertyType === 'undefined'){
  471. //		return rawPropertyValue;
  472. //	}
  473. 	else
  474. 		return rawPropertyValue;
  475. };
  476. /**  @memberOf mmir.parser.ParsingResult */
  477. ParsingResult.prototype.hasVarReferences = function(){
  478. 	return false;//TODO implement this
  479. };
  480. /**  @memberOf mmir.parser.ParsingResult */
  481. ParsingResult.prototype.isScriptTag = function(){
  482. 	if( parser.element.INCLUDE_SCRIPT === this.getType() ){
  483. 		return true;
  484. 	}
  485. 	return false;
  486. };
  487. /**  @memberOf mmir.parser.ParsingResult */
  488. ParsingResult.prototype.isStyleTag = function(){
  489. 	if( parser.element.INCLUDE_STYLE === this.getType() ){
  490. 		return true;
  491. 	}
  492. 	return false;
  493. };
  494. /**  @memberOf mmir.parser.ParsingResult */
  495. ParsingResult.prototype.isLocalize = function(){
  496. 	if( parser.element.LOCALIZE === this.getType() ){
  497. 		return true;
  498. 	}
  499. 	return false;
  500. };
  501. /**  @memberOf mmir.parser.ParsingResult */
  502. ParsingResult.prototype.isYield = function(){
  503. 	if( parser.element.YIELD_DECLARATION === this.getType() ){
  504. 		return true;
  505. 	}
  506. 	return false;
  507. };
  508. /**  @memberOf mmir.parser.ParsingResult */
  509. ParsingResult.prototype.isYieldContent = function(){
  510. 	if( parser.element.YIELD_CONTENT === this.getType() ){
  511. 		return true;
  512. 	}
  513. 	return false;
  514. };
  515. /**  @memberOf mmir.parser.ParsingResult */
  516. ParsingResult.prototype.isScriptBlock = function(){
  517. 	if( parser.element.BLOCK === this.getType() ){
  518. 		return true;
  519. 	}
  520. 	return false;
  521. };
  522. /**  @memberOf mmir.parser.ParsingResult */
  523. ParsingResult.prototype.isScriptStatement = function(){
  524. 	if( parser.element.STATEMENT === this.getType() ){
  525. 		return true;
  526. 	}
  527. 	return false;
  528. };
  529. /**  @memberOf mmir.parser.ParsingResult */
  530. ParsingResult.prototype.isHelper = function(){
  531. 	if( parser.element.HELPER === this.getType() ){
  532. 		return true;
  533. 	}
  534. 	return false;
  535. };
  536. /**  @memberOf mmir.parser.ParsingResult */
  537. ParsingResult.prototype.isIf = function(){
  538. 	if( parser.element.IF === this.getType() ){
  539. 		return true;
  540. 	}
  541. 	return false;
  542. };
  543. /**  @memberOf mmir.parser.ParsingResult */
  544. ParsingResult.prototype.hasElse = function(){
  545. 	if(this.isIf() && typeof this.elseContent != 'undefined'){
  546. 		return true;
  547. 	}
  548. 	return false;
  549. };
  550. /**  @memberOf mmir.parser.ParsingResult */
  551. ParsingResult.prototype.isElse = function(){
  552. 	if( parser.element.ELSE === this.getType() ){
  553. 		return true;
  554. 	}
  555. 	return false;
  556. };
  557. /**  @memberOf mmir.parser.ParsingResult */
  558. ParsingResult.prototype.isFor = function(){
  559. 	if( parser.element.FOR === this.getType() ){
  560. 		return true;
  561. 	}
  562. 	return false;
  563. };
  564. /**  @memberOf mmir.parser.ParsingResult */
  565. ParsingResult.prototype.isRender = function(){
  566. 	if( parser.element.RENDER === this.getType() ){
  567. 		return true;
  568. 	}
  569. 	return false;
  570. };
  571. /**  @memberOf mmir.parser.ParsingResult */
  572. ParsingResult.prototype.isEscapeEnter = function(){
  573. 	if( parser.element.ESCAPE_ENTER === this.getType() ){
  574. 		return true;
  575. 	}
  576. 	return false;
  577. };
  578. /**  @memberOf mmir.parser.ParsingResult */
  579. ParsingResult.prototype.isEscapeExit = function(){
  580. 	if( parser.element.ESCAPE_EXIT === this.getType() ){
  581. 		return true;
  582. 	}
  583. 	return false;
  584. };
  585. /**  @memberOf mmir.parser.ParsingResult */
  586. ParsingResult.prototype.isEscape = function(){
  587. 	return this.isEscapeEnter() || this.isEscapeExit();
  588. };
  590. /**
  591.  * WARNING: do use sparingly -- an invocation triggers a list evaluation.
  592.  *
  593.  * @returns {String} a String representation (name) for this ParsingResult's type
  594.  *
  595.  * @memberOf mmir.parser.ParsingResult
  596.  */
  598. ParsingResult.prototype.getTypeName = function(){
  600. 	if(this.typeName){
  601. 		return this.typeName;/////////////////// EARLY EXIT //////////////////////////
  602. 	}
  604. 	for(var prop in parser.element){
  605. 		if(parser.element.hasOwnProperty(prop) && parser.element[prop] === this.getType()){
  606. 			this.typeName = prop;
  607. 			return prop;/////////////////// EARLY EXIT //////////////////////////
  608. 		}
  609. 	}
  611. 	return void(0);
  612. };
  613. /**  @memberOf mmir.parser.ParsingResult */
  614. ParsingResult.prototype.hasCallData = function(){
  615. 	return typeof this.dataPos !== 'undefined';
  616. };
  617. /**  @memberOf mmir.parser.ParsingResult */
  618. ParsingResult.prototype.getCallDataStart = function(){
  619. 	return this.dataPos.start;
  620. };
  621. /**  @memberOf mmir.parser.ParsingResult */
  622. ParsingResult.prototype.getCallDataEnd = function(){
  623. 	return this.dataPos.end;
  624. };
  625. /**  @memberOf mmir.parser.ParsingResult */
  626. ParsingResult.prototype.getCallDataType = function(){
  627. 	return this.dataType;
  628. };
  629. /**  @memberOf mmir.parser.ParsingResult */
  630. ParsingResult.prototype.stringify = function(disableStrictMode){
  632. 	//TODO use constants for lists
  634. 	//typed properties:
  635. 	// for each typed properties '<prop>' there is an additional property with name '<prop>Type'
  636. 	// (both of these properties are Strings themselves)
  637. 	var typedPropList = [
  638. 		'scriptPath',
  639. 		'stylePath',
  640. 		'name',
  641. 		'helper',
  642. 		'partial',
  643. 		'controller'
  644. 	];
  646. 	//primitive-type properties:
  647. 	// write values 'as is' for these properties
  648. 	var propList = [
  649. 			'start',
  650. 		'end',
  651. 		'type',
  652. 		'dataType',
  653. 		'text',
  654. 		'forControlType',
  655. 		'forPropName'
  656. 	];
  658. 	//"stringify-able" object properties:
  659. 	var strPropList = [
  660. 			'content',
  661. 			'elseContent'
  662. 		];
  664. 	//function properties:
  665. 	var funcPropList = [
  666. 	//DISABLED these are now generated/initialized in the owning ContentElment's initEvalFunctions() function (NOTE that this may include the forInitEval too, which then will overwrite this function, that may be exported due to this list)
  667. //   	     'scriptEval',
  668. //   	     'argsEval',
  669. //   	     'ifEval',
  670. //   	     'forConditionEval',
  671. //   	     'forIncrementEval',
  672. 			'forInitEval',//TODO include this in ContentElement.initEvalFunctions
  673. 			'forIterator'//TODO include this in ContentElement.initEvalFunctions
  674. 		];
  676. 	//default function properties:
  677. 	// these functions from the prototype may have been overwritten
  678. 	//  -> if one is overwritten, i.e. not the default implementation, then store that one too
  679. 	var overwrittenFuncPropList = [
  680. 		'getEnd',
  681. 			'getStart',
  682. 			'getType',
  683. 			'getValue',
  684. 			'getTypeName',
  685. 			'getCallDataStart',
  686. 			'getCallDataEnd',
  687. 			'getCallDataType'
  688. 		];
  690. 	//function for iterating over the property-list and generating JSON-like entries in the string-buffer
  691. 	var  appendStringified = parser.appendStringified;
  693. 	var sb = ['require("mmirf/storageUtils").restoreObject({ classConstructor: "mmirf/parsingResult"', ','];
  695. 	//TODO property dataPos: {start: Number, end: Number}
  696. 	if(this['dataPos']){
  697. 		sb.push( 'dataPos:{start:' );
  698. 		sb.push( this.dataPos.start );
  699. 		sb.push( ',end:' );
  700. 		sb.push( this.dataPos.end );
  701. 		sb.push( '}' );
  702. 		//NOTE: need to add comma in a separate entry
  703. 		//      (-> in order to not break the removal method of last comma, see below)
  704. 		sb.push( ',' );
  705. 	}
  708. 	appendStringified(this, typedPropList, sb);
  709. 	appendStringified(this, typedPropList, sb, 'Type');
  710. 	appendStringified(this, propList, sb);
  711. 	//non-primitives with stringify() function:
  712. 	appendStringified(this, strPropList, sb, null, function stringifyableExtractor(name, value){
  713. 		return value.stringify(disableStrictMode);
  714. 	});
  715. 	//function definitions
  716. 	appendStringified(this, funcPropList, sb, null, function functionExtractor(name, value){
  717. 		return value.toString();
  718. 	});
  719. 	//add "overwritten" function definitions
  720. 	appendStringified(this, overwrittenFuncPropList, sb, null, function nonDefaultFunctionExtractor(name, value){
  721. 		var instanceImpl = value.toString();
  722. 		var defaultImpl = ParsingResult.prototype[name].toString();
  723. 		if(instanceImpl !== defaultImpl){
  724. 			return instanceImpl;
  725. 		}
  726. 		//DEFAULT: return void (will omit this from storage -> use default impl. of the prototype)
  727. 		return;
  728. 	});
  730. 	//if last element is a comma, remove it
  731. 	if(sb[sb.length - 1] === ','){
  732. 		sb.splice( sb.length - 1, 1);
  733. 	}
  735. 	sb.push(' })');
  736. 	return sb.join('');
  737. };
  739. /**
  740.  * HELPER for making the namespace of the core-parser (i.e. ANTLR3) available
  741.  *
  742.  * This is necessary in environments where the namespace is not automatically
  743.  *  exported into the global namespace, e.g. when runnin in nodejs.
  744.  *
  745.  * @static
  746.  * @private
  747.  * @param {String} parserNamerspace
  748.  * 			the namespace object of the ANTLR parser (should be the object org which is exported by antlr3 module/shim)
  749.  */
  750. ParsingResult._nsParserInit = function(parserNamerspace){
  752. 	_antrl3 = parserNamerspace;
  754. 	if(typeof org === 'undefined'){
  755. 		org = parserNamerspace;
  756. 	}
  757. };
  759. parser.ParsingResult = ParsingResult;
  761. return parser.ParsingResult;
  763. });//END: define(..., function(){