org.omp4j.preprocessor

Preprocessor

class Preprocessor extends AnyRef

Class representing the preprocessor itself.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Preprocessor
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Preprocessor()(implicit conf: Config)

    Create preprocessor for given files.

    Create preprocessor for given files.

    conf

    the preprocessor configuration

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Preprocessor to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Preprocessor, B)

    Implicit information
    This member is added by an implicit conversion from Preprocessor to ArrowAssoc[Preprocessor] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (Preprocessor) ⇒ Boolean, msg: ⇒ Any): Preprocessor

    Implicit information
    This member is added by an implicit conversion from Preprocessor to Ensuring[Preprocessor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Preprocessor) ⇒ Boolean): Preprocessor

    Implicit information
    This member is added by an implicit conversion from Preprocessor to Ensuring[Preprocessor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): Preprocessor

    Implicit information
    This member is added by an implicit conversion from Preprocessor to Ensuring[Preprocessor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Preprocessor

    Implicit information
    This member is added by an implicit conversion from Preprocessor to Ensuring[Preprocessor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Preprocessor to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. def parseFile(file: File): (CommonTokenStream, Java8Parser, CompilationUnitContext)

    Parse one particular file.

    Parse one particular file.

    file

    Valid source file to be parsed

    Exceptions thrown
    ParseException

    if unexpected error occurs

    SyntaxErrorException

    if OMP directive has invalid syntax

  25. def run(firstRun: Boolean = true): (Array[File], List[(File, File)])

    Recursively translate all files until some directive exists.

    Recursively translate all files until some directive exists.

    The work-flow of the preprocessor is as follows:

    • Configuration creation (accept conf)
    • Code analysis
    • Directive recognition
    • Top-level directives translation (according to hierarchy model)
    • Saving the output
    • Recursive call

    The penultimate tuple of second list represents the directories where translated source files are really stored

    firstRun

    true if this is the first recursion level, false otherwise

    returns

    a tuple containing an array of translated files and the list of tuples of working and preprocessed directories

    Exceptions thrown
    CompilationException

    if file cannot be compiled by Java compiler

    ParseException

    if an parsing-related error occurred

    SyntaxErrorException

    if syntax error in the directive occurred

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  27. def toString(): String

    Definition Classes
    AnyRef → Any
  28. def validate(parsed: Array[(File, (CommonTokenStream, Java8Parser, CompilationUnitContext))]): Unit

    Validate sources passed.

    Validate sources passed.

    The method is not meant for external usage, however it may come in handy

    parsed

    An array of file and parsed AST properties

    Exceptions thrown
    CompilationException

    if validation fails

  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def [B](y: B): (Preprocessor, B)

    Implicit information
    This member is added by an implicit conversion from Preprocessor to ArrowAssoc[Preprocessor] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Preprocessor to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (preprocessor: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Preprocessor to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (preprocessor: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Preprocessor

    Implicit information
    This member is added by an implicit conversion from Preprocessor to ArrowAssoc[Preprocessor] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (preprocessor: ArrowAssoc[Preprocessor]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Preprocessor

    Implicit information
    This member is added by an implicit conversion from Preprocessor to Ensuring[Preprocessor] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (preprocessor: Ensuring[Preprocessor]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Preprocessor to StringAdd

Inherited by implicit conversion any2stringfmt from Preprocessor to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Preprocessor to ArrowAssoc[Preprocessor]

Inherited by implicit conversion any2Ensuring from Preprocessor to Ensuring[Preprocessor]

Ungrouped