Gjsify LogoGjsify Logo

The data structure representing a lexical scanner.

You should set input_name after creating the scanner, since it is used by the default message handler when displaying warnings and errors. If you are scanning a file, the filename would be a good choice.

The user_data and max_parse_errors fields are not used. If you need to associate extra data with the scanner you can place them here.

If you want to use your own message handler you can set the msg_handler field. The type of the message handler function is declared by #GScannerMsgFunc.

record

Hierarchy

  • Scanner

Index

Constructors

Properties

link into the scanner configuration

field
input_name: string

name of input stream, featured by the default message handler

field
line: number

line number of the last token from g_scanner_get_next_token()

field
max_parse_errors: number

unused

field
msg_handler: ScannerMsgFunc

handler function for _warn and _error

field
next_line: number

line number of the last token from g_scanner_peek_next_token()

field
next_position: number

char number of the last token from g_scanner_peek_next_token()

field
next_token: GLib.TokenType

token parsed by the last g_scanner_peek_next_token()

field
next_value: TokenValue

value of the last token from g_scanner_peek_next_token()

field
parse_errors: number

g_scanner_error() increments this field

field
position: number

char number of the last token from g_scanner_get_next_token()

field
qdata: GLib.Data

quarked data

field

token parsed by the last g_scanner_get_next_token()

field
user_data: object

unused

field
value: TokenValue

value of the last token from g_scanner_get_next_token()

field
name: string

Methods

  • cur_line(): number
  • Returns the current line in the input stream (counting from 1). This is the line of the last token parsed via g_scanner_get_next_token().

    Returns number

  • cur_position(): number
  • Returns the current position in the current line (counting from 0). This is the position of the last token parsed via g_scanner_get_next_token().

    Returns number

  • destroy(): void
  • eof(): boolean
  • Parses the next token just like g_scanner_peek_next_token() and also removes it from the input stream. The token data is placed in the token, value, line, and position fields of the #GScanner structure.

    Returns GLib.TokenType

  • input_file(input_fd: number): void
  • input_text(text: string, text_len: number): void
  • Prepares to scan a text buffer.

    Parameters

    • text: string

      the text buffer to scan

    • text_len: number

      the length of the text buffer

    Returns void

  • lookup_symbol(symbol: string): object
  • Looks up a symbol in the current scope and return its value. If the symbol is not bound in the current scope, %NULL is returned.

    Parameters

    • symbol: string

      the symbol to look up

    Returns object

  • Parses the next token, without removing it from the input stream. The token data is placed in the next_token, next_value, next_line, and next_position fields of the #GScanner structure.

    Note that, while the token is not removed from the input stream (i.e. the next call to g_scanner_get_next_token() will return the same token), it will not be reevaluated. This can lead to surprising results when changing scope or the scanner configuration after peeking the next token. Getting the next token after switching the scope or configuration will return whatever was peeked before, regardless of any symbols that may have been added or removed in the new scope.

    Returns GLib.TokenType

  • scope_add_symbol(scope_id: number, symbol: string, value: object): void
  • Adds a symbol to the given scope.

    Parameters

    • scope_id: number

      the scope id

    • symbol: string

      the symbol to add

    • value: object

      the value of the symbol

    Returns void

  • scope_lookup_symbol(scope_id: number, symbol: string): object
  • Looks up a symbol in a scope and return its value. If the symbol is not bound in the scope, %NULL is returned.

    Parameters

    • scope_id: number

      the scope id

    • symbol: string

      the symbol to look up

    Returns object

  • scope_remove_symbol(scope_id: number, symbol: string): void
  • Removes a symbol from a scope.

    Parameters

    • scope_id: number

      the scope id

    • symbol: string

      the symbol to remove

    Returns void

  • set_scope(scope_id: number): number
  • sync_file_offset(): void
  • Rewinds the filedescriptor to the current buffer position and blows the file read ahead buffer. This is useful for third party uses of the scanners filedescriptor, which hooks onto the current scanning position.

    Returns void

  • unexp_token(expected_token: GLib.TokenType, identifier_spec: string, symbol_spec: string, symbol_name: string, message: string, is_error: number): void
  • Outputs a message through the scanner's msg_handler, resulting from an unexpected token in the input stream. Note that you should not call g_scanner_peek_next_token() followed by g_scanner_unexp_token() without an intermediate call to g_scanner_get_next_token(), as g_scanner_unexp_token() evaluates the scanner's current token (not the peeked token) to construct part of the message.

    Parameters

    • expected_token: GLib.TokenType

      the expected token

    • identifier_spec: string

      a string describing how the scanner's user refers to identifiers (%NULL defaults to "identifier"). This is used if expected_token is %G_TOKEN_IDENTIFIER or %G_TOKEN_IDENTIFIER_NULL.

    • symbol_spec: string

      a string describing how the scanner's user refers to symbols (%NULL defaults to "symbol"). This is used if expected_token is %G_TOKEN_SYMBOL or any token value greater than %G_TOKEN_LAST.

    • symbol_name: string

      the name of the symbol, if the scanner's current token is a symbol.

    • message: string

      a message string to output at the end of the warning/error, or %NULL.

    • is_error: number

      if %TRUE it is output as an error. If %FALSE it is output as a warning.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method