@haxall/haxall
    Preparing search index...

    Class XetoSpec

    XetoSpec is the referential proxy for MSpec

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Identifier for a spec is always its qualified name This is a temp shim until we move haystack::Dict fully into Xeto.

      Returns Ref

    • MSpecArgs

      Returns MSpecArgs

    • Assembled XetoSpec (stub only in AST until Assemble step)

      Returns XetoSpec

    • Base spec from which this spec directly inherits its meta and slots. Returns null if this is sys::Obj itself.

      Returns Spec

    • Binding for spec type

      Returns SpecBinding

    • Base spec or null if this sys::Obj itself

      Returns CSpec

    • Lookup enum item by its key - raise exception if not enum type

      Parameters

      • key: string
      • Optionalchecked: boolean

      Returns CSpec

    • Return if spec inherits from that from a nominal type perspective. This is the same behavior as Spec.isa, just using CSpec (XetoSpec or AST)

      Parameters

      Returns boolean

    • Effective meta

      Returns MNameDict

    • Return if effective meta has given slot name

      Parameters

      • name: string

      Returns boolean

    • Return item for seq/ref

      Returns XetoSpec

    • Return list of component specs for a compound type

      Returns List<XetoSpec>

    • 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

    • Parent spec which contains this spec definition and scopes name. Returns null for top level specs in the library.

      Returns CSpec

    • Lookup effective slot

      Parameters

      • n: string
      • Optionalc: boolean

      Returns CSpec

    • Iterate the effective slots as map

      Parameters

      • f: (arg0: CSpec, arg1: string) => void

      Returns void

    • Iterate the effective slots as map

      Parameters

      Returns JsObj

    • Type of the spec or if this a type then return self

      Returns CSpec

    • Get display string for dict or the given tag. If name is null, then return display text for the entire dict using Etc.dictToDis. If name is non-null then format the tag value using its appropiate toLocale method. If name is not defined by this dict, then return def.

      Parameters

      • Optionalname: string
      • Optionaldef: string

      Returns string

    • Iterate through the name/value pairs

      Parameters

      • f: (arg0: JsObj, arg1: string) => void

      Returns void

    • Iterate through the name/value pairs until the given function returns non-null, then break the iteration and return resulting object. Return null if function returns null for every name/value pair.

      Parameters

      Returns JsObj

    • Return enum item meta. Raise exception if isEnum is false.

      Returns SpecEnum

    • 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

    • Returns Type

    • MSpecFlags bitmask flags

      Returns number

    • Flavor: type, global, meta, slot

      Returns SpecFlavor

    • Return function specific APIs. Raise exception if isFunc is false.

      Returns SpecFunc

    • Get the value for the given name or def if name not mapped

      Parameters

      • n: string
      • Optionald: JsObj

      Returns JsObj

    • Return true if this dictionary contains given name

      Parameters

      • n: string

      Returns boolean

    • 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

    • Is there one or more effective slots

      Returns boolean

    • Get the id tag as a Ref or raise CastErr/UnknownNameErr

      Returns Ref

    • Return if this spec inherits from that from a nominal type perspective. Nonimal typing matches any of the following conditions:

      • if that matches one of this inherited specs via base
      • if this is maybe and that is None
      • if this is And and that matches any this.ofs
      • if this is Or and that matches all this.ofs (common base)
      • if that is Or and this matches any of that.ofs

      Parameters

      Returns boolean

    • Is base sys::And

      Returns boolean

    • Return if this an AST ASpec

      Returns boolean

    • Return if this is a spec that inherits from sys::Choice. If this spec inherits from a choice via a And/Or type then return false. See LibNamespace.choice to access SpecChoice API.

      Returns boolean

    • Inherits from sys.comp::Comp without considering And/Or

      Returns boolean

    • Does this spec directly inherits from And/Or and define ofs

      Returns boolean

    • Inherits from sys::Dict without considering And/Or

      Returns boolean

    • Return if the there are no name/value pairs

      Returns boolean

    • Is the base sys::Enum

      Returns boolean

    • Return if this a FuncSpec that models a function signature

      Returns boolean

    • Returns boolean

    • 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

    • Inherits from sys::Interface without considering And/Or

      Returns boolean

    • Inherits from sys::List without considering And/Or

      Returns boolean

    • Inherits from sys::Marker without considering And/Or

      Returns boolean

    • Does meta have maybe tag

      Returns boolean

    • Returns boolean

    • Inherits from sys::MultiRef without considering And/Or

      Returns boolean

    • Is this the sys::None spec

      Returns boolean

    • Is base sys::Or

      Returns boolean

    • Inherits from sys::Query without considering And/Or

      Returns boolean

    • Inherits from sys::Ref without considering And/Or

      Returns boolean

    • Inherits from sys::Scalar without considering And/Or

      Returns boolean

    • Is this the sys::Self spec

      Returns boolean

    • Returns boolean

    • Is this spec in the sys library

      Returns boolean

    • Returns boolean

    • Parent library for spec

      Returns Lib

    • Returns FileLoc

    • Returns MSpec

    • Create a new instance of this dict with the same names, but apply the specified closure to generate new values.

      Parameters

      Returns this

    • Get my effective meta; this does not include synthesized tags like spec

      Returns Dict

    • Get my own declared meta-data

      Returns Dict

    • Return true if this dictionary does not contain given name

      Parameters

      • n: string

      Returns boolean

    • Return simple name scoped by lib or parent.

      Returns string

    • Parameters

      • Optionalchecked: boolean

      Returns Spec

    • Parameters

      • Optionalchecked: boolean

      Returns List<Spec>

    • Parent spec which contains this spec definition and scopes name. Returns null for top level specs in the library.

      Returns Spec

    • Return fully qualified name of this spec:

      • Type specs will return "foo.bar::Baz"
      • Global slots will return "foo.bar::baz"
      • Type slots will return "foo.bar::Baz.qux"
      • Derived specs will return "derived123::{name}"

      Returns string

    • Convenience for slots.get

      Parameters

      • n: string
      • Optionalc: boolean

      Returns Spec

    • Convenience for slotsOwn.get

      Parameters

      • n: string
      • Optionalc: boolean

      Returns Spec

    • Get the effective children slots including inherited

      Returns SpecSlots

    • Get the declared children slots

      Returns SpecSlots

    • 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

    • Type of this spec. If this spec is a top level type then return self.

      Returns Spec

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

      Returns Type

    • 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

    • Parameters

      • ...args: unknown[]

      Returns XetoSpec

    • Parameters

      • m: MSpec
      • ...args: unknown[]

      Returns XetoSpec