@haxall/haxall
    Preparing search index...

    Class Scanner

    Scanner is a utility class for parsing lines

    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

    • 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

    • Scan until we find the given ch. Return the number of characters skipped, or -1 if we hit the end of the line.

      Parameters

      • ch: number

      Returns number

    • Consume characters until the given function returns true, or the end-of-line is reached. Return the number of characters skipped, or -1 if we reach the end.

      Parameters

      • f: (arg0: number) => boolean

      Returns number

    • 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

    • Are there more characters to consume

      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

    • Consume characters while the given function returns true and return the number of characters consumed.

      Parameters

      • f: (arg0: number) => boolean

      Returns number

    • Consume as many ch in a row as possible and return the number consumed.

      Parameters

      • ch: number

      Returns number

    • Advance the scanner to the next character

      Returns void

    • Check if the specified char is next and advance the position.

      ch: the char to check (including newline chars)

      Return true if matched and position was advanced; false otherwise

      Parameters

      • ch: number

      Returns boolean

    • Check if we have the specified content on the line and advance the position. Note that if you want to match newline characters, use nextCh.

      content: the text content to match on a single line (excluding newline)

      Return true if matched and position was advanced; false otherwise

      Parameters

      • content: string

      Returns boolean

    • Peek at the next character without consuming it

      Returns number

    • Peek at the next code point

      Returns number

    • Peek at the previous codepoint

      Returns number

    • Get the current position (current line, index into that line)

      Returns Position

    • Set the current position for the scanner

      Parameters

      Returns void

    • For cases where the caller appends the result to a StrBuf, we could offer another method to avoid some unnecessary copying.

      Parameters

      Returns SourceLines

    • 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

    • Consume whitespace and return the number of whitespace characters consumed

      Whitespace is defined as space, \t, \n, \u000B, \f, and \r

      Returns number

    • 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

      • lines: List<SourceLine>
      • OptionallineIndex: number
      • Optionalindex: number
      • ...args: unknown[]

      Returns Scanner

    • Parameters

      Returns Scanner

    • Parameters

      Returns Scanner