Namespace: go.std.go.scanner

v1.0

Contents

• Summary
• Index
• Constants
• Variables
• Functions, Macros, and Special Forms
• Types

Summary

Provides a low-level interface to the go/scanner package.

Package scanner implements a scanner for Go source text.
It takes a []byte as source which can then be tokenized
through repeated calls to the Scan method.

Index

• *Error
• *ErrorHandler
• *ErrorList
• *Mode
• *Scanner
• Error
• ErrorHandler
• ErrorList
• Mode
• PrintError
• ScanComments
• Scanner
• arrayOfError
• arrayOfErrorHandler
• arrayOfErrorList
• arrayOfMode
• arrayOfScanner

Legend

Constant Variable Function Macro Special form Type GoVar Receiver/Method

Constants

Constants are variables with :const true in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.

(None.)

Variables

• ScanComments

  GoObject v1.0

  return comments as COMMENT tokens
  

Functions, Macros, and Special Forms

• PrintError

  Function v1.0

  (PrintError w err)
  

  PrintError is a utility function that prints a list of errors to w,
  one error per line, if the err parameter is an ErrorList. Otherwise
  it prints the err string.
  
  Go input arguments: (w io.Writer, err error)
  
  Joker input arguments: [^go.std.io/Writer w, ^Error err]

Types

• *Error

  Concrete Type v1.0

  In an ErrorList, an error is represented by an *Error.
  The position Pos, if valid, points to the beginning of
  the offending token, and the error condition is described
  by Msg.
  

• *ErrorHandler

  Concrete Type v1.0

  An ErrorHandler may be provided to Scanner.Init. If a syntax error is
  encountered and a handler was installed, the handler is called with a
  position and an error message. The position points to the beginning of
  the offending token.
  

• *ErrorList

  Concrete Type v1.0

  ErrorList is a list of *Errors.
  The zero value for an ErrorList is an empty ErrorList ready to use.
  

• Add

  Receiver for *ErrorList v1.0

  ([pos msg])
  

  Add adds an Error with given position and error message to an ErrorList.
  

• RemoveMultiples

  Receiver for *ErrorList v1.0

  ([])
  

  RemoveMultiples sorts an ErrorList and removes all but the first error per line.
  

• Reset

  Receiver for *ErrorList v1.0

  ([])
  

  Reset resets an ErrorList to no errors.
  

• *Mode

  Concrete Type v1.0

  A mode value is a set of flags (or 0).
  They control scanner behavior.
  

• *Scanner

  Concrete Type v1.0

  A Scanner holds the scanner's internal state while processing
  a given text. It can be allocated as part of another data
  structure but must be initialized via Init before use.
  

• Init

  Receiver for *Scanner v1.0

  ([file src err mode])
  

  Init prepares the scanner s to tokenize the text src by setting the
  scanner at the beginning of src. The scanner uses the file set file
  for position information and it adds line information for each line.
  It is ok to re-use the same file when re-scanning the same file as
  line information which is already present is ignored. Init causes a
  panic if the file size does not match the src size.
  
  Calls to Scan will invoke the error handler err if they encounter a
  syntax error and err is not nil. Also, for each error encountered,
  the Scanner field ErrorCount is incremented by one. The mode parameter
  determines how comments are handled.
  
  Note that Init may call err if there is an error in the first character
  of the file.
  

• Scan

  Receiver for *Scanner v1.0

  ([])
  

  Scan scans the next token and returns the token position, the token,
  and its literal string if applicable. The source end is indicated by
  token.EOF.
  
  If the returned token is a literal (token.IDENT, token.INT, token.FLOAT,
  token.IMAG, token.CHAR, token.STRING) or token.COMMENT, the literal string
  has the corresponding value.
  
  If the returned token is a keyword, the literal string is the keyword.
  
  If the returned token is token.SEMICOLON, the corresponding
  literal string is ";" if the semicolon was present in the source,
  and "\n" if the semicolon was inserted because of a newline or
  at EOF.
  
  If the returned token is token.ILLEGAL, the literal string is the
  offending character.
  
  In all other cases, Scan returns an empty literal string.
  
  For more tolerant parsing, Scan will return a valid token if
  possible even if a syntax error was encountered. Thus, even
  if the resulting token sequence contains no illegal tokens,
  a client may not assume that no error occurred. Instead it
  must check the scanner's ErrorCount or the number of calls
  of the error handler, if there was one installed.
  
  Scan adds line information to the file added to the file
  set with Init. Token positions are relative to that file
  and thus relative to the file set.
  

• Error

  Concrete Type v1.0

  In an ErrorList, an error is represented by an *Error.
  The position Pos, if valid, points to the beginning of
  the offending token, and the error condition is described
  by Msg.
  

• Error

  Receiver for Error v1.0

  ([])
  

  Error implements the error interface.
  

• ErrorHandler

  Concrete Type v1.0

  An ErrorHandler may be provided to Scanner.Init. If a syntax error is
  encountered and a handler was installed, the handler is called with a
  position and an error message. The position points to the beginning of
  the offending token.
  

• ErrorList

  Concrete Type v1.0

  ErrorList is a list of *Errors.
  The zero value for an ErrorList is an empty ErrorList ready to use.
  

• Err

  Receiver for ErrorList v1.0

  ([])
  

  Err returns an error equivalent to this error list.
  If the list is empty, Err returns nil.
  

• Error

  Receiver for ErrorList v1.0

  ([])
  

  An ErrorList implements the error interface.
  

• Len

  Receiver for ErrorList v1.0

  ([])
  

  ErrorList implements the sort Interface.
  

• Less

  Receiver for ErrorList v1.0

  ([i j])
  

• Sort

  Receiver for ErrorList v1.0

  ([])
  

  Sort sorts an ErrorList. *Error entries are sorted by position,
  other errors are sorted by error message, and before any *Error
  entry.
  

• Swap

  Receiver for ErrorList v1.0

  ([i j])
  

• Mode

  Concrete Type v1.0

  A mode value is a set of flags (or 0).
  They control scanner behavior.
  

• Scanner

  Concrete Type v1.0

  A Scanner holds the scanner's internal state while processing
  a given text. It can be allocated as part of another data
  structure but must be initialized via Init before use.
  

• arrayOfError

  Concrete Type v1.0

  In an ErrorList, an error is represented by an *Error.
  The position Pos, if valid, points to the beginning of
  the offending token, and the error condition is described
  by Msg.
  

• arrayOfErrorHandler

  Concrete Type v1.0

  An ErrorHandler may be provided to Scanner.Init. If a syntax error is
  encountered and a handler was installed, the handler is called with a
  position and an error message. The position points to the beginning of
  the offending token.
  

• arrayOfErrorList

  Concrete Type v1.0

  ErrorList is a list of *Errors.
  The zero value for an ErrorList is an empty ErrorList ready to use.
  

• arrayOfMode

  Concrete Type v1.0

  A mode value is a set of flags (or 0).
  They control scanner behavior.
  

• arrayOfScanner

  Concrete Type v1.0

  A Scanner holds the scanner's internal state while processing
  a given text. It can be allocated as part of another data
  structure but must be initialized via Init before use.