Packages

c

info.kwarc.mmt.api.checking

MMTStructureChecker

class MMTStructureChecker extends Checker

A StructureChecker traverses structural elements and checks them, calling the object checker as needed.

After checking an element, it is immediately elaborated.

Deriving classes may override unitCont and reCont to customize the behavior.

Source
MMTStructureChecker.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MMTStructureChecker
  2. Checker
  3. LeveledExtension
  4. ObjectChecker
  5. StructureChecker
  6. FormatBasedExtension
  7. Extension
  8. Logger
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MMTStructureChecker(objectChecker: ObjectChecker)

Type Members

  1. case class LocalError(s: String) extends ExtensionError with Product with Serializable

    a custom error class for this extension

    a custom error class for this extension

    Definition Classes
    Extension

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(e: StructuralElement)(implicit ce: CheckingEnvironment): Unit

    checks the entire StructuralElement

    checks the entire StructuralElement

    Definition Classes
    MMTStructureCheckerStructureChecker
  5. def apply(cu: CheckingUnit, rules: RuleSet)(implicit env: CheckingEnvironment): CheckingResult

    relegates to objectChecker

    relegates to objectChecker

    cu

    the checking unit to check

    rules

    rules to use during checking

    env

    continuation functions

    Definition Classes
    CheckerObjectChecker
  6. def apply(p: Path)(implicit env: CheckingEnvironment): Unit

    checks a StructuralElement, given by its URI

    checks a StructuralElement, given by its URI

    Definition Classes
    StructureChecker
  7. def applyElementBegin(e: StructuralElement)(implicit ce: CheckingEnvironment): Unit

    checks the header of a StructuralElement, i.e., everything except for its body

    checks the header of a StructuralElement, i.e., everything except for its body

    Definition Classes
    MMTStructureCheckerStructureChecker
  8. def applyElementEnd(e: ContainerElement[_])(implicit ce: CheckingEnvironment): Unit

    checks the end of a StructuralElement (e.g., global conditions like totality of a view)

    checks the end of a StructuralElement (e.g., global conditions like totality of a view)

    Definition Classes
    MMTStructureCheckerStructureChecker
  9. def applyWithTimeout(e: StructuralElement, t: Option[Int])(implicit ce: CheckingEnvironment): Unit

    generalization of apply to allow for a timeout for generated type checking tasks

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def catchErrors[A](msg: String, recoverWith: ⇒ A)(code: ⇒ A): A

    like its partner but with return value

    like its partner but with return value

    Attributes
    protected
    Definition Classes
    Extension
  12. def catchErrors(msg: String)(code: ⇒ Unit): Unit

    convenience method for wrapping code in error handler that throws LocalError

    convenience method for wrapping code in error handler that throws LocalError

    Attributes
    protected
    Definition Classes
    Extension
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. val controller: Controller

    the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field

    the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field

    Attributes
    protected
    Definition Classes
    Extension
  15. lazy val defaultPrefix: String
    Definition Classes
    Extension
  16. def destroy: Unit

    extension-specific cleanup (override as needed, empty by default)

    extension-specific cleanup (override as needed, empty by default)

    Extensions may create persistent data structures and threads, but they must clean up after themselves in this method

    Definition Classes
    LeveledExtensionExtension
  17. def destroyWhenRemainingTasksFinished: Unit

    convenience for calling waitUntilRemainingTasksFinished and then destroy

    convenience for calling waitUntilRemainingTasksFinished and then destroy

    Definition Classes
    Extension
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def getFromFirstArgOrEnvvar(args: List[String], name: String, default: String = ""): String
    Attributes
    protected
    Definition Classes
    Extension
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. val id: String
    Definition Classes
    MMTStructureCheckerChecker
  25. def init(controller: Controller): Unit

    MMT initialization (idempotent)

    MMT initialization (idempotent)

    Definition Classes
    LeveledExtensionExtension
  26. def initOther(e: Extension): Unit

    any extension can initialize other extensions if those are not meant to be added to the ExtensionManager

    any extension can initialize other extensions if those are not meant to be added to the ExtensionManager

    Attributes
    protected
    Definition Classes
    Extension
  27. def isApplicable(s: String): Boolean

    returns

    true if this extension is applicable

    Definition Classes
    CheckerFormatBasedExtension
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def log(e: Error): Unit

    logs an error - always logged

    logs an error - always logged

    Attributes
    protected
    Definition Classes
    Logger
  30. def log(s: ⇒ String, subgroup: Option[String] = None): Unit

    logs a message with this logger's logprefix

    logs a message with this logger's logprefix

    Attributes
    protected
    Definition Classes
    Logger
  31. def logError(s: ⇒ String): Unit

    log as an error message

    log as an error message

    Attributes
    protected
    Definition Classes
    Logger
  32. def logGroup[A](a: ⇒ A): A

    wraps around a group to create nested logging

    wraps around a group to create nested logging

    Attributes
    protected
    Definition Classes
    Logger
  33. val logPrefix: String

    the prefix used to identify this extension for logging, by default the class name

    the prefix used to identify this extension for logging, by default the class name

    Definition Classes
    MMTStructureCheckerExtensionLogger
  34. def logTemp(s: ⇒ String): Unit

    temporary logging - always logged

    temporary logging - always logged

    Attributes
    protected
    Definition Classes
    Logger
  35. def makeErrorThrower(msg: String): ErrorHandler

    an ErrorHandler that wraps an error in a LocalError and throws it

    an ErrorHandler that wraps an error in a LocalError and throws it

    Attributes
    protected
    Definition Classes
    Extension
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. val objectLevel: ObjectChecker
    Definition Classes
    CheckerLeveledExtension
  40. val report: Report
    Attributes
    protected
    Definition Classes
    ExtensionLogger
  41. def start(args: List[String]): Unit

    extension-specific initialization (override as needed, empty by default)

    extension-specific initialization (override as needed, empty by default)

    Definition Classes
    Extension
  42. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  47. def waitUntilRemainingTasksFinished: Unit

    extensions that process tasks in separate threads should override this and wait until those threads are done

    extensions that process tasks in separate threads should override this and wait until those threads are done

    Definition Classes
    Extension

Deprecated Value Members

  1. def elabContext(th: Theory)(implicit ce: CheckingEnvironment): Context
    Annotations
    @MMT_TODO( message = "unclear what happens here" )
    Deprecated

    unclear what happens here

Inherited from Checker

Inherited from LeveledExtension

Inherited from ObjectChecker

Inherited from StructureChecker

Inherited from FormatBasedExtension

Inherited from Extension

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped