ee.cyber.simplicitas.parse

OptionRule

class OptionRule extends NonTerminalRule

Option rules:

option Foo: Bar | Baz;

linear super types: NonTerminalRule, Rule, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. OptionRule
  2. NonTerminalRule
  3. Rule
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new OptionRule (pName: String, pTree: List[Any], symbols: SymbolTable)

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def actualReturnType : String

    Returns return type of the method corresponding to this rule.

    Returns return type of the method corresponding to this rule. Uses name of the rule if explicit return type is not given.

    definition classes: Rule
  9. def analyze () : Unit

    Performs initial analysis of the AST.

    Performs initial analysis of the AST. Basically, processes the tree to extract Scala code, explicit return type and calls to other rules (that will become constructor parameters for generated Scala classes later).

    definition classes: Rule
  10. def antlrName : String

    Returns name of the rule as it will appear in the ANTLR code.

    Returns name of the rule as it will appear in the ANTLR code.

    definition classes: NonTerminalRuleRule
  11. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  12. var body : String

    Code that will be added to the body of the generated Scala class.

    Code that will be added to the body of the generated Scala class.

    definition classes: Rule
  13. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  14. def collectParams () : Unit

    Analyse the rule body to find all the calls to other rules.

    Analyse the rule body to find all the calls to other rules. The concrete implementation depends on the type of rule.

    definition classes: OptionRuleRule
  15. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  16. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  17. val error : (Any, String) ⇒ Nothing

    Error reporting function.

    Error reporting function.

    definition classes: Rule
  18. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  19. def generateClasses () : Unit

    Generate RuleClass objects and insert them to the symbol table.

    Generate RuleClass objects and insert them to the symbol table. This includes also modifications to existing classes (e.g., adding extends clause).

    New classes can (and should be) directly generated. However, modifications to other classes should be delayed because the other classes might not be generated yet. Therefore, these modifications should be saved as actions @see SymbolTable.actions

    definition classes: OptionRuleRule
  20. def generateGrammar (buf: StringBuilder) : Unit

    Generates code for ANTLR grammar.

    Generates code for ANTLR grammar.

    buf

    Buffer that will contain the code.

    definition classes: Rule
  21. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  22. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  23. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  24. def isTerminalRule : Boolean

    Returns true, if this is terminal or fragment rule.

    Returns true, if this is terminal or fragment rule.

    definition classes: NonTerminalRuleRule
  25. def matchBody () : Unit

    Checks for code that will be inserted to generated Scala class.

    Checks for code that will be inserted to generated Scala class.

    attributes: protected
    definition classes: Rule
  26. val name : String

    definition classes: Rule
  27. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  28. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  29. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  30. def paramValue (param: RuleParam) : String

    Returns the ANTLR code for constructing value for a parameter.

    Returns the ANTLR code for constructing value for a parameter. The parameter's name can be read from param. The parameter calls this rule.

    definition classes: NonTerminalRuleRule
  31. var params : ArrayBuffer[RuleParam]

    Other rules called by this rule.

    Other rules called by this rule.

    definition classes: Rule
  32. var returnCode : String

    Return expression for the rule.

    Return expression for the rule.

    definition classes: Rule
  33. var returnType : String

    Return type of the rule, if explicitly specified.

    Return type of the rule, if explicitly specified.

    definition classes: Rule
  34. def ruleAfter (implicit buf: ArrayBuffer[String]) : Unit

    Generate the "@after" clause in the ANTLR rule, if necessary.

    Generate the "@after" clause in the ANTLR rule, if necessary.

    attributes: protected
    definition classes: Rule
  35. def ruleBody (implicit buf: ArrayBuffer[String]) : Unit

    Generate the main body of the ANTLR rule.

    Generate the main body of the ANTLR rule.

    definition classes: OptionRuleRule
  36. def ruleInit (implicit buf: ArrayBuffer[String]) : Unit

    Generate the "@init" clause in the ANTLR rule, if necessary.

    Generate the "@init" clause in the ANTLR rule, if necessary.

    attributes: protected
    definition classes: Rule
  37. def rulePrefix : String

    Returns prefix for the ANTLR rule.

    Returns prefix for the ANTLR rule. Used in fragment rules.

    attributes: protected
    definition classes: Rule
  38. def ruleReturns : String

    Returns the "returns [Foo]" clause in the ANTLR grammar, if appropriate.

    Returns the "returns [Foo]" clause in the ANTLR grammar, if appropriate.

    definition classes: NonTerminalRuleRule
  39. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  40. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: Rule → AnyRef → Any
  41. var tree : List[Any]

    definition classes: Rule
  42. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  43. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  44. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  45. def wrapInReturn (expr: String) : String

    Wrap code in expr to call to "returns expression" of this rule.

    Wrap code in expr to call to "returns expression" of this rule.

    attributes: protected
    definition classes: NonTerminalRule

Inherited from NonTerminalRule

Inherited from Rule

Inherited from AnyRef

Inherited from Any