Class (GI Struct)

GLib-2.0 ▶ GLib ▶ Scanner

GLib.Scanner provides a general-purpose 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 GLib.ScannerMsgFunc.

Index

Constructors

constructor

Properties

config input_name line max_parse_errors msg_handler next_line next_position next_token next_value parse_errors position token user_data value $gtype

Methods

cur_line cur_position cur_token destroy eof get_next_token input_file input_text lookup_symbol peek_next_token scope_add_symbol scope_foreach_symbol scope_lookup_symbol scope_remove_symbol set_scope sync_file_offset unexp_token

Constructors

Properties

config: ScannerConfig
input_name: string
line: number
max_parse_errors: number
msg_handler: ScannerMsgFunc
next_line: number
next_position: number
next_token: TokenType
next_value: TokenValue
parse_errors: number
position: number
token: TokenType
user_data: any
value: TokenValue
$gtype: GType<Scanner>

Methods

  • 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

    the current line

  • 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

    the current position on the line

  • Returns true if the scanner has reached the end of the file or text buffer.

    Returns boolean

    true if the scanner has reached the end of the file or text buffer

  • 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 GLib.Scanner structure.

    Returns TokenType

    the type of the token

  • Prepares to scan a file.

    Parameters

    • input_fd: number

      a file descriptor

    Returns void

input_text

  • 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

  • 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 any

    the value of symbol in the current scope, or null if symbol is not bound in the current scope

  • 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 GLib.Scanner 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 TokenType

    the type of the token

  • Adds a symbol to the given scope.

    Parameters

    • scope_id: number

      the scope id

    • symbol: string

      the symbol to add

    • Optionalvalue: any

      the value of the symbol

    Returns void

  • Calls the given function for each of the symbol/value pairs in the given scope of the GLib.Scanner. The function is passed the symbol and value of each pair, and the given user_data parameter.

    Parameters

    • scope_id: number

      the scope id

    • func: HFunc

      the function to call for each symbol/value pair

    Returns void

  • 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 any

    the value of symbol in the given scope, or null if symbol is not bound in the given scope.

  • Removes a symbol from a scope.

    Parameters

    • scope_id: number

      the scope id

    • symbol: string

      the symbol to remove

    Returns void

  • Sets the current scope.

    Parameters

    • scope_id: number

      the new scope id

    Returns number

    the old scope id

  • 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

  • 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: 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 GLib.TokenType.IDENTIFIER or GLib.TokenType.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 GLib.TokenType.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