@haxall/haxall
    Preparing search index...

    Class HxdDefCompiler

    DefCompiler

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Compile all the formats and docs

      Returns this

    • Compile into dist zip file

      Returns this

    • Compile into DefDocEnv model (but don't generate HTML files)

      Returns DefDocEnv

    • Compile into HTML documentation under outDir

      Returns this

    • Compile pods to an index

      Returns CIndex

    • Compile into one or more formats from command line Main

      Parameters

      • formats: List<string>
      • protos: boolean

      Returns this

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Log err message

      Parameters

      • msg: string
      • loc: CLoc
      • Optionalcause: Err

      Returns CompilerErr

    • Log err message with two locations of duplicate identifiers

      Parameters

      Returns CompilerErr

    • Factory to use for building Namespace and Features

      Returns DefFactory

    • Factory to use for building Namespace and Features

      Parameters

      • it: DefFactory

      Returns void

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Callback used to filter which defs are included in the docs. If a lib def itself returns false then all of its defs are excluded too. The default implementation only checks for the nodoc marker. If you override the default implmentation, then your custom callback must check for nodoc too.

      Returns (arg0: CDef) => boolean

    • Callback used to filter which defs are included in the docs. If a lib def itself returns false then all of its defs are excluded too. The default implementation only checks for the nodoc marker. If you override the default implmentation, then your custom callback must check for nodoc too.

      Parameters

      • it: (arg0: CDef) => boolean

      Returns void

    • Include data specs in output documentation

      Returns boolean

    • Include data specs in output documentation

      Parameters

      • it: boolean

      Returns void

    • Log info message

      Parameters

      • msg: string

      Returns void

    • Initialize output directory

      Returns File

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Error and warning logging

      Returns Log

    • Error and warning logging

      Parameters

      Returns void

    • Callback for each document file generated. If left as null it will output a file to the outDir using the ".html" file extension. If non-null then no file extension is applied and only the body content is generated

      Returns (arg0: DocFile) => void

    • Callback for each document file generated. If left as null it will output a file to the outDir using the ".html" file extension. If non-null then no file extension is applied and only the body content is generated

      Parameters

      Returns void

    • Output directory for compiler/documentation results

      Returns File

    • Output directory for compiler/documentation results

      Parameters

      Returns void

    • Returns HxdRuntime

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • Callback to undefine specific defs during compilation

      Parameters

      Returns boolean

    • Log err message

      Parameters

      • msg: string
      • loc: CLoc
      • Optionalcause: Err

      Returns void

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void