MMIR Framework

Class: ParsingResult

mmir.parser. ParsingResult

new mmir.parser.ParsingResult(thetokens)

mvc/parser/parsingResult.js, line 16
ParsingResult represents an element that was detected during parsing.

The detected element is referenced by the properties start and end that refer to the start-index and end-index within the parsed text.

The ParsingResult has a type property which refers to the kind of element that was detected (see constants in mmir.parser.Element).

In addition, the ParsingResult may have several properties that depend of its type. In general, these properties refer to detected parts of the element (e.g. for a invocation-statement, these may refer to its arguments).

Properties for INCLUDE_SCRIPT type:

  • scriptPath: the path / URL to the resource
  • scriptPathType: the type of the scriptPath field: one of StringLiteral, Identifier, IdentifierNameAmpersatStart

Properties for INCLUDE_STYLE type:

  • stylePath:
  • stylePathType: the type of the stylePath field: one of StringLiteral, Identifier, IdentifierNameAmpersatStart

Properties for LOCALIZE type:

  • name: the name/identifier for the localized String
  • nameType: the type of the name field: one of StringLiteral, Identifier, IdentifierNameAmpersatStart

Properties for YIELD_DECLARATION type:

  • name: the name/identifier for the yield section
  • nameType: the type of the name field: one of StringLiteral, Identifier, IdentifierNameAmpersatStart
Properties for BLOCK type:
  • scriptContent {String}: OPTIONALLY the script code as a String
  • scriptEval {Function}: the compiled script code in form of a function. The function takes one argument: the current data-object.

Properties for STATEMENT type:

  • scriptContent {String}: OPTIONALLY the script code as a String
  • scriptEval {Function}: the compiled script code in form of a function. The function takes one argument: the current data-object.

Properties for HELPER type:

  • helper: the name of the helper function
  • helperType: the type of the helper field: one of StringLiteral, Identifier, IdentifierNameAmpersatStart
  • argsEval {Function}: OPTIONALLY compiled getter Function for retrieving the current ARGS (optional argument) of the helper expression. The function takes one argument: the current data-object.

Properties for IF type:

  • ifEval {Function}: the condition statement, that was compiled into a Function. The function takes one argument: the current data-object.
  • content {ContentElement}: the HTML / template content that should be render, in case the if-expression evaluates to true.
  • elseContent mmir.parser.ParsingResult: OPTIONALLY a ParsingResult representing an else-expression, see mmir.parser.Element.ELSE.

Properties for ELSE type:

  • content {ContentElement}: the HTML / template content that should be render, in case the if-expression (to which the else-expression belongs) evaluates to false.

Properties for FOR type:

  • forControlType {String}: the type of for-loop, either FORITER or FORSTEP
  • forInitEval {Function}: the initialization statement of the for-expression, compiled into a Function. The function takes one argument: the current data-object.
  • FORITER: @for(PROP in OBJ){ ... }@
    • forIterator {Object}: an iterator object with functions hasNext() : Boolean and next() : String (which returns the name of the property currently iterated).
    • forPropName {String}: the variable name for the property which is currently iterated over.
  • FORSTEP: @for(INIT; CONDITION; INCREMENT){ ... }@
    • forConditionEval {Function}: the condition statement of the for-expression, compiled into a Function. The function takes one argument: the current data-object.
    • forIncrementEval {Function}: the increment statement of the for-expression, compiled into a Function. The function takes one argument: the current data-object.
  • content {ContentElement}: the HTML / template content that should be rendered during each iteration of the for-loop.

Properties for RENDER type:

  • partial: the name of the partial view
  • partialType: the type of the partial field: one of StringLiteral, Identifier, IdentifierNameAmpersatStart
  • controller: the name of the controller, to which the partial view definition belongs
  • controllerType: the type of the controller field: one of StringLiteral, Identifier, IdentifierNameAmpersatStart
  • argsEval {Function}: OPTIONALLY compiled getter Function for retrieving the current ARGS (optional argument) of the render expression. The function takes one argument: the current data-object.

Properties for ESCAPE_ENTER type:

  • text {String}: the text that will be rendered (i.e. without the escape-character(s) itself).

Properties for ESCAPE_EXIT type:

  • text {String}: the text that will be rendered (i.e. without the escape-character(s) itself).

Properties for VAR_DECLARATION type:

  • name: the name for the variable (without the leading @ of template variables)
  • nameType: the type of the name field: StringLiteral

Name Type Description
thetokens org.antlr.runtime.CommonTokenStream | org.antlr.runtime.Token optional OPTIONAL if org.antlr.runtime.CommonTokenStream: the TokenStream that corresponds to this parsed element; when provided, the TokenStream is used to set the start- and end- property of the new instance.
if org.antlr.runtime.Token: if the parameter is a single Token object, then the start- and end- property for the new instance is set by this token object

Methods

staticmmir.parser.ParsingResult.ParsingResult#getCallDataEnd()

mvc/parser/parsingResult.js, line 622

staticmmir.parser.ParsingResult.ParsingResult#getCallDataStart()

mvc/parser/parsingResult.js, line 618

staticmmir.parser.ParsingResult.ParsingResult#getCallDataType()

mvc/parser/parsingResult.js, line 626

staticmmir.parser.ParsingResult.ParsingResult#getEnd()

mvc/parser/parsingResult.js, line 415

staticmmir.parser.ParsingResult.ParsingResult#getStart()

mvc/parser/parsingResult.js, line 411

staticmmir.parser.ParsingResult.ParsingResult#getType(){mmir.parser.Element}

mvc/parser/parsingResult.js, line 430
Get the type of this parsed element, i.e. as which type this element was parsed. The type corresponds to one of the type defined in {mmir.parser.Element}.
Returns:
Type Description
mmir.parser.Element the type for this ParsingResult

staticmmir.parser.ParsingResult.ParsingResult#getTypeName(){String}

mvc/parser/parsingResult.js, line 598
WARNING: do use sparingly -- an invocation triggers a list evaluation.
Returns:
Type Description
String a String representation (name) for this ParsingResult's type

staticmmir.parser.ParsingResult.ParsingResult#getValue()

mvc/parser/parsingResult.js, line 441
helper function for converting properties to the correct value. By default, the ParsingResult only contains "raw" property values. Which properties are available, depends on the type of the ParsingResult (see templateProcessor.js)

staticmmir.parser.ParsingResult.ParsingResult#hasCallData()

mvc/parser/parsingResult.js, line 614

staticmmir.parser.ParsingResult.ParsingResult#hasElse()

mvc/parser/parsingResult.js, line 544

staticmmir.parser.ParsingResult.ParsingResult#hasVarReferences()

mvc/parser/parsingResult.js, line 477

staticmmir.parser.ParsingResult.ParsingResult#isElse()

mvc/parser/parsingResult.js, line 551

staticmmir.parser.ParsingResult.ParsingResult#isEscape()

mvc/parser/parsingResult.js, line 586

staticmmir.parser.ParsingResult.ParsingResult#isEscapeEnter()

mvc/parser/parsingResult.js, line 572

staticmmir.parser.ParsingResult.ParsingResult#isEscapeExit()

mvc/parser/parsingResult.js, line 579

staticmmir.parser.ParsingResult.ParsingResult#isFor()

mvc/parser/parsingResult.js, line 558

staticmmir.parser.ParsingResult.ParsingResult#isHelper()

mvc/parser/parsingResult.js, line 530

staticmmir.parser.ParsingResult.ParsingResult#isIf()

mvc/parser/parsingResult.js, line 537

staticmmir.parser.ParsingResult.ParsingResult#isLocalize()

mvc/parser/parsingResult.js, line 495

staticmmir.parser.ParsingResult.ParsingResult#isRender()

mvc/parser/parsingResult.js, line 565

staticmmir.parser.ParsingResult.ParsingResult#isScriptBlock()

mvc/parser/parsingResult.js, line 516

staticmmir.parser.ParsingResult.ParsingResult#isScriptStatement()

mvc/parser/parsingResult.js, line 523

staticmmir.parser.ParsingResult.ParsingResult#isScriptTag()

mvc/parser/parsingResult.js, line 481

staticmmir.parser.ParsingResult.ParsingResult#isStyleTag()

mvc/parser/parsingResult.js, line 488

staticmmir.parser.ParsingResult.ParsingResult#isYield()

mvc/parser/parsingResult.js, line 502

staticmmir.parser.ParsingResult.ParsingResult#isYieldContent()

mvc/parser/parsingResult.js, line 509

staticmmir.parser.ParsingResult.ParsingResult#setEndFrom(thetokens)

mvc/parser/parsingResult.js, line 401
Set the end position (index) for this parsed element with regard to the TokenStream of the complete input.
Name Type Description
thetokens org.antlr.runtime.CommonTokenStream (optional) the TokenStream that corresponds to this parsed element; when provided, the TokenStream is used to set the end-property of this object.

staticmmir.parser.ParsingResult.ParsingResult#setStartFrom(thetokens)

mvc/parser/parsingResult.js, line 381
Set the start position (index) for this parsed element with regard to the TokenStream of the complete input.
Name Type Description
thetokens org.antlr.runtime.CommonTokenStream (optional) the TokenStream that corresponds to this parsed element; when provided, the TokenStream is used to set the start-property of this object.

staticmmir.parser.ParsingResult.ParsingResult#stringify()

mvc/parser/parsingResult.js, line 630