ee.cyber.simplicitas.imp

APluginConfig

class APluginConfig extends AnyRef

This class offers the main entry point for customising the IDE of the DSL. Override methods in this class to create your own IDE.

attributes: abstract
linear super types: AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. APluginConfig
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new APluginConfig ()

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 addToTree (node: CommonNode) : Boolean

    Return true, if this node should be shown in the outline view.

    Return true, if this node should be shown in the outline view. The default implementation shows nodes for which thetreeLabel method returns non-null label.

  9. 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
  10. def canBeCompleted (token: GenericToken) : Boolean

    Return true, if auto-completion should take the given token into account.

    Return true, if auto-completion should take the given token into account. In general, this is used to signal that white space, punctuation, operators etc. cannot be completed.

    For example, let's assume that the user presses ctrl-space at word "abc|def" ("|" marks cursor position). If this method returns true, Eclipse tries to find completion, starting with prefix "abc". If this method returns false, the completion prefix is "" instead.

  11. 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
  12. 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
  13. 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
  14. def fences : Array[(String, String)]

    Return pair of matching brackets that will be highlighted in the code editor.

    Return pair of matching brackets that will be highlighted in the code editor. For example: Array(("(", ")"), ("[", "]"))

  15. def fileImage (file: IFile) : Image

    Return icon that will be displayed in the editor tab showing this file.

    Return icon that will be displayed in the editor tab showing this file. Normally, the images are loaded inYourLangConfig.loadImages method and stored in theYourLangConfig object. The images must be 16x16 pixels.

  16. 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
  17. 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
  18. def getDocumentation (node: CommonNode) : String

    Return text that will be shown as documentation hover for that node.

    Return text that will be shown as documentation hover for that node. You can use HTML tags in the text.

  19. def getLinkText (node: CommonNode) : String

    This method is called to determint the text that will be shown in a hover when the node behaves as link.

    This method is called to determint the text that will be shown in a hover when the node behaves as link. TODO: Currently does noot work as advertised.

  20. def getTokenColor (token: GenericToken) : Symbol

    Returns color symbol for given token (or null, if no coloring).

    Returns color symbol for given token (or null, if no coloring). Simpl uses one level of indirection with syntax-coloring service. On the first level, the getTokenColor method returns symbol corresponding to token kind, such as 'comment, 'definition, etc. On the second level, the YourLanguageNameConfig object contains information for each token kind, such as human-readable name, default color and font style. It is important that the two pieces of information are in sync and that the getTokenColor method only return symbols that are described in the table at the YuorLanguageNameConfig object.

  21. 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
  22. def isFoldable (node: CommonNode) : Boolean

    Return true, if this node should be made foldable.

    Return true, if this node should be made foldable. The default implementation makes node foldable if it is also shown in the outline view.

  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 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
  25. 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
  26. 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
  27. def parse (ctx: ParseCtx) : Unit

    Parse the source file.

    Parse the source file. Basically, this method exists to get access to DSL-specific Grammar class. The simplest implementation of this method for language Foo is:
    ctx.parse(new FooGrammar())
    In addition to parsing, you should perform program validation in this method. For reporting validation errors, use

    attributes: abstract
      see also:
    1. ParseCtx#reportErrors method.

  28. def propose (ctx: ProposalCtx) : Unit

    Find proposals for auto-completion.

    Find proposals for auto-completion. See the documentation for ProposalCtx for further information.

  29. def referenceTarget (node: CommonNode) : CommonNode

    If the node represents a link, then return the object that it points to.

    If the node represents a link, then return the object that it points to. This service is used by Eclipse to make some tokens behave as hyperlinks. It is also used by hover helper (for links, the hover text is documentation of the link target).

  30. def runGenerator (directory: String, file: String) : Unit

    Run the code generator for given file.

    Run the code generator for given file. This method is called when the user selects "Generate" from the drop-down menu in Navigator window.

    directory

    full path to directory where the DSL file is located.

    file

    file that was selected for generation. File name is relative to the directory parameter.

  31. def singleLineCommentPrefix : String

    Return prefix for single-line comments.

    Return prefix for single-line comments. This is used to automatically comment-uncomment lines of text.

  32. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  33. 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: AnyRef → Any
  34. def treeImage (node: CommonNode) : Image

    Return icon that will be used to annotate this node in the outline view.

    Return icon that will be used to annotate this node in the outline view. Normally, the images are loaded inYourLangConfig.loadImages method and stored in theYourLangConfig object. The images must be 16x16 pixels.

  35. def treeLabel (node: CommonNode) : String

    Return label that will be shown for that node in the outline view.

    Return label that will be shown for that node in the outline view. The default implementation of the addToTreemethod shows only nodes that have label.

    attributes: abstract
  36. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef

Inherited from AnyRef

Inherited from Any