GI.GLib.Structs.Scanner

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.

Exported types

newtype Scanner

Constructors

Scanner (ForeignPtr Scanner)

Instances

WrappedPtr Scanner

Methods

wrappedPtrCalloc :: IO (Ptr Scanner)

wrappedPtrCopy :: Ptr Scanner -> IO (Ptr Scanner)

wrappedPtrFree :: Maybe (FunPtr (Ptr Scanner -> IO ()))

(~) AttrOpTag tag AttrSet => Constructible Scanner tag

Methods

new :: MonadIO m => (ForeignPtr Scanner -> Scanner) -> [AttrOp Scanner tag] -> m Scanner

((~) * info (ResolveScannerMethod t Scanner), MethodInfo * info Scanner p) => IsLabel t (Scanner -> p)

Methods

fromLabel :: Proxy# Symbol t -> Scanner -> p

((~) * info (ResolveScannerMethod t Scanner), MethodInfo * info Scanner p) => IsLabelProxy t (Scanner -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Scanner -> p

((~) * signature (TokenType -> Text -> Text -> Text -> Text -> Int32 -> m ()), MonadIO m) => MethodInfo * ScannerUnexpTokenMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerUnexpTokenMethodInfo Scanner -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * ScannerSyncFileOffsetMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerSyncFileOffsetMethodInfo Scanner -> signature -> s

((~) * signature (Word32 -> m Word32), MonadIO m) => MethodInfo * ScannerSetScopeMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerSetScopeMethodInfo Scanner -> signature -> s

((~) * signature (Word32 -> Text -> m ()), MonadIO m) => MethodInfo * ScannerScopeRemoveSymbolMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerScopeRemoveSymbolMethodInfo Scanner -> signature -> s

((~) * signature (Word32 -> Text -> Ptr () -> m ()), MonadIO m) => MethodInfo * ScannerScopeAddSymbolMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerScopeAddSymbolMethodInfo Scanner -> signature -> s

((~) * signature (m TokenType), MonadIO m) => MethodInfo * ScannerPeekNextTokenMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerPeekNextTokenMethodInfo Scanner -> signature -> s

((~) * signature (Text -> Word32 -> m ()), MonadIO m) => MethodInfo * ScannerInputTextMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerInputTextMethodInfo Scanner -> signature -> s

((~) * signature (Int32 -> m ()), MonadIO m) => MethodInfo * ScannerInputFileMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerInputFileMethodInfo Scanner -> signature -> s

((~) * signature (m TokenType), MonadIO m) => MethodInfo * ScannerGetNextTokenMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerGetNextTokenMethodInfo Scanner -> signature -> s

((~) * signature (m Bool), MonadIO m) => MethodInfo * ScannerEofMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerEofMethodInfo Scanner -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * ScannerDestroyMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerDestroyMethodInfo Scanner -> signature -> s

((~) * signature (m TokenType), MonadIO m) => MethodInfo * ScannerCurTokenMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerCurTokenMethodInfo Scanner -> signature -> s

((~) * signature (m Word32), MonadIO m) => MethodInfo * ScannerCurPositionMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerCurPositionMethodInfo Scanner -> signature -> s

((~) * signature (m Word32), MonadIO m) => MethodInfo * ScannerCurLineMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerCurLineMethodInfo Scanner -> signature -> s

type AttributeList Scanner

type AttributeList Scanner

newZeroScanner :: MonadIO m => m Scanner

Construct a Scanner struct initialized to zero.

noScanner :: Maybe Scanner

Methods

scannerCurLine

data ScannerCurLineMethodInfo

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * ScannerCurLineMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerCurLineMethodInfo Scanner -> signature -> s

scannerCurLine :: MonadIO m => Scanner -> m Word32

scannerCurPosition

data ScannerCurPositionMethodInfo

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * ScannerCurPositionMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerCurPositionMethodInfo Scanner -> signature -> s

scannerCurPosition :: MonadIO m => Scanner -> m Word32

scannerCurToken

data ScannerCurTokenMethodInfo

Instances

((~) * signature (m TokenType), MonadIO m) => MethodInfo * ScannerCurTokenMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerCurTokenMethodInfo Scanner -> signature -> s

scannerCurToken :: MonadIO m => Scanner -> m TokenType

scannerDestroy

data ScannerDestroyMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * ScannerDestroyMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerDestroyMethodInfo Scanner -> signature -> s

scannerDestroy :: MonadIO m => Scanner -> m ()

scannerEof

data ScannerEofMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * ScannerEofMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerEofMethodInfo Scanner -> signature -> s

scannerEof :: MonadIO m => Scanner -> m Bool

scannerGetNextToken

data ScannerGetNextTokenMethodInfo

Instances

((~) * signature (m TokenType), MonadIO m) => MethodInfo * ScannerGetNextTokenMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerGetNextTokenMethodInfo Scanner -> signature -> s

scannerGetNextToken :: MonadIO m => Scanner -> m TokenType

scannerInputFile

data ScannerInputFileMethodInfo

Instances

((~) * signature (Int32 -> m ()), MonadIO m) => MethodInfo * ScannerInputFileMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerInputFileMethodInfo Scanner -> signature -> s

scannerInputFile :: MonadIO m => Scanner -> Int32 -> m ()

scannerInputText

data ScannerInputTextMethodInfo

Instances

((~) * signature (Text -> Word32 -> m ()), MonadIO m) => MethodInfo * ScannerInputTextMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerInputTextMethodInfo Scanner -> signature -> s

scannerInputText :: MonadIO m => Scanner -> Text -> Word32 -> m ()

scannerPeekNextToken

data ScannerPeekNextTokenMethodInfo

Instances

((~) * signature (m TokenType), MonadIO m) => MethodInfo * ScannerPeekNextTokenMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerPeekNextTokenMethodInfo Scanner -> signature -> s

scannerPeekNextToken :: MonadIO m => Scanner -> m TokenType

scannerScopeAddSymbol

data ScannerScopeAddSymbolMethodInfo

Instances

((~) * signature (Word32 -> Text -> Ptr () -> m ()), MonadIO m) => MethodInfo * ScannerScopeAddSymbolMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerScopeAddSymbolMethodInfo Scanner -> signature -> s

scannerScopeAddSymbol :: MonadIO m => Scanner -> Word32 -> Text -> Ptr () -> m ()

scannerScopeRemoveSymbol

data ScannerScopeRemoveSymbolMethodInfo

Instances

((~) * signature (Word32 -> Text -> m ()), MonadIO m) => MethodInfo * ScannerScopeRemoveSymbolMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerScopeRemoveSymbolMethodInfo Scanner -> signature -> s

scannerScopeRemoveSymbol :: MonadIO m => Scanner -> Word32 -> Text -> m ()

scannerSetScope

data ScannerSetScopeMethodInfo

Instances

((~) * signature (Word32 -> m Word32), MonadIO m) => MethodInfo * ScannerSetScopeMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerSetScopeMethodInfo Scanner -> signature -> s

scannerSetScope :: MonadIO m => Scanner -> Word32 -> m Word32

scannerSyncFileOffset

data ScannerSyncFileOffsetMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * ScannerSyncFileOffsetMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerSyncFileOffsetMethodInfo Scanner -> signature -> s

scannerSyncFileOffset :: MonadIO m => Scanner -> m ()

scannerUnexpToken

data ScannerUnexpTokenMethodInfo

Instances

((~) * signature (TokenType -> Text -> Text -> Text -> Text -> Int32 -> m ()), MonadIO m) => MethodInfo * ScannerUnexpTokenMethodInfo Scanner signature

Methods

overloadedMethod :: MethodProxy ScannerUnexpTokenMethodInfo Scanner -> signature -> s

scannerUnexpToken :: MonadIO m => Scanner -> TokenType -> Text -> Text -> Text -> Text -> Int32 -> m ()

Properties

Config

scannerClearConfig :: MonadIO m => Scanner -> m ()

scannerConfig :: AttrLabelProxy "config"

scannerReadConfig :: MonadIO m => Scanner -> m (Maybe ScannerConfig)

scannerWriteConfig :: MonadIO m => Scanner -> Ptr ScannerConfig -> m ()

InputName

scannerClearInputName :: MonadIO m => Scanner -> m ()

scannerInputName :: AttrLabelProxy "inputName"

scannerReadInputName :: MonadIO m => Scanner -> m (Maybe Text)

scannerWriteInputName :: MonadIO m => Scanner -> CString -> m ()

Line

scannerLine :: AttrLabelProxy "line"

scannerReadLine :: MonadIO m => Scanner -> m Word32

scannerWriteLine :: MonadIO m => Scanner -> Word32 -> m ()

MaxParseErrors

scannerMaxParseErrors :: AttrLabelProxy "maxParseErrors"

scannerReadMaxParseErrors :: MonadIO m => Scanner -> m Word32

scannerWriteMaxParseErrors :: MonadIO m => Scanner -> Word32 -> m ()

NextLine

scannerNextLine :: AttrLabelProxy "nextLine"

scannerReadNextLine :: MonadIO m => Scanner -> m Word32

scannerWriteNextLine :: MonadIO m => Scanner -> Word32 -> m ()

NextPosition

scannerNextPosition :: AttrLabelProxy "nextPosition"

scannerReadNextPosition :: MonadIO m => Scanner -> m Word32

scannerWriteNextPosition :: MonadIO m => Scanner -> Word32 -> m ()

NextToken

scannerNextToken :: AttrLabelProxy "nextToken"

scannerReadNextToken :: MonadIO m => Scanner -> m TokenType

scannerWriteNextToken :: MonadIO m => Scanner -> TokenType -> m ()

NextValue

scannerClearNextValue :: MonadIO m => Scanner -> m ()

scannerNextValue :: AttrLabelProxy "nextValue"

scannerReadNextValue :: MonadIO m => Scanner -> m (Maybe TokenValue)

scannerWriteNextValue :: MonadIO m => Scanner -> Ptr TokenValue -> m ()

ParseErrors

scannerParseErrors :: AttrLabelProxy "parseErrors"

scannerReadParseErrors :: MonadIO m => Scanner -> m Word32

scannerWriteParseErrors :: MonadIO m => Scanner -> Word32 -> m ()

Position

scannerPosition :: AttrLabelProxy "position"

scannerReadPosition :: MonadIO m => Scanner -> m Word32

scannerWritePosition :: MonadIO m => Scanner -> Word32 -> m ()

Qdata

scannerClearQdata :: MonadIO m => Scanner -> m ()

scannerQdata :: AttrLabelProxy "qdata"

scannerReadQdata :: MonadIO m => Scanner -> m (Maybe Data)

scannerWriteQdata :: MonadIO m => Scanner -> Ptr Data -> m ()

Token

scannerReadToken :: MonadIO m => Scanner -> m TokenType

scannerToken :: AttrLabelProxy "token"

scannerWriteToken :: MonadIO m => Scanner -> TokenType -> m ()

UserData

scannerClearUserData :: MonadIO m => Scanner -> m ()

scannerReadUserData :: MonadIO m => Scanner -> m (Ptr ())

scannerUserData :: AttrLabelProxy "userData"

scannerWriteUserData :: MonadIO m => Scanner -> Ptr () -> m ()

Value

scannerClearValue :: MonadIO m => Scanner -> m ()

scannerReadValue :: MonadIO m => Scanner -> m (Maybe TokenValue)

scannerValue :: AttrLabelProxy "value"

scannerWriteValue :: MonadIO m => Scanner -> Ptr TokenValue -> m ()