#include <gimbal_scanner.h>

Inheritance diagram for GblScanner:

[legend]

Collaboration diagram for GblScanner:

[legend]

Data Fields
union {

GblScannerClass * pClass

GblObject base

};

GblStringView	token

GblStringView	next

GblStringRef *	pError

GBL_SCANNER_FLAGS	status

Data Fields inherited from GblObject
union {

GblObjectClass * pClass

GblBox base

};

Data Fields inherited from GblInstance
GblClass *	pClass

Related Symbols
(Note that these are not member symbols.)
Input and Delimeters
Methods for setting input and delimeter pattern
GblStringRef *	GblScanner_input (const GblScanner *pSelf)

void	GblScanner_setInput (GblScanner pSelf, const char pStr, size_t count)

void	GblScanner_setInputRef (GblScanner pSelf, GblStringRef pRef)

GblStringRef *	GblScanner_delimeters (const GblScanner *pSelf)

void	GblScanner_setDelimeters (GblScanner pSelf, const char pPattern)

Errors
Methods for managing errors
void	GblScanner_clearError (GblScanner *pSelf)

void	GblScanner_raiseError (GblScanner pSelf, GblFlags flags, const char pFmt,...)

Stream
Methods for controlling the input stream
void	GblScanner_reset (GblScanner *pSelf)

size_t	GblScanner_tell (const GblScanner *pSelf)

GblBool	GblScanner_seek (GblScanner *pSelf, int whence)

Cursor
Methods for managing the stream cursor
const GblScannerCursor *	GblScanner_cursor (const GblScanner *pSelf, size_t depth)

size_t	GblScanner_cursorDepth (const GblScanner *pSelf)

GBL_RESULT	GblScanner_pushCursor (GblScanner *pSelf)

GBL_RESULT	GblScanner_popCursor (GblScanner *pSelf)

Scanning
Methods for scanning the next token
GblBool	GblScanner_scanToken (GblScanner *pSelf)

GblBool	GblScanner_scanMatch (GblScanner pSelf, const char pPat)

GblBool	GblScanner_scanPattern (GblScanner pSelf, const GblPattern pPat)

GblBool	GblScanner_scanLines (GblScanner *pSelf, size_t lines)

GblBool	GblScanner_scanBytes (GblScanner *pSelf, size_t bytes)

GblBool	GblScanner_scanBool (GblScanner pSelf, GblBool pBool)

GblBool	GblScanner_scanChar (GblScanner pSelf, char pChar)

GblBool	GblScanner_scanUint8 (GblScanner pSelf, uint8_t pUint)

GblBool	GblScanner_scanUint16 (GblScanner pSelf, uint16_t pUint)

GblBool	GblScanner_scanInt16 (GblScanner pSelf, int16_t pInt)

GblBool	GblScanner_scanInt32 (GblScanner pSelf, int32_t pInt)

GblBool	GblScanner_scanUint32 (GblScanner pSelf, uint32_t pUint)

GblBool	GblScanner_scanInt64 (GblScanner pSelf, int64_t pInt)

GblBool	GblScanner_scanUint64 (GblScanner pSelf, uint64_t pUint)

GblBool	GblScanner_scanFloat (GblScanner pSelf, float pFloat)

GblBool	GblScanner_scanDouble (GblScanner pSelf, double pDouble)

GblBool	GblScanner_scanType (GblScanner *pSelf, GblType t,...)

GblBool	GblScanner_scanTypeVa (GblScanner pSelf, GblType t, va_list pVa)

#define	GblScanner_scan(self, ptr)

Peeking
Methods for peeking at the next token
GblBool	GblScanner_peekToken (GblScanner *pSelf)

GblBool	GblScanner_peekMatch (GblScanner pSelf, const char pMatch)

GblBool	GblScanner_peekPattern (GblScanner pSelf, const GblPattern pPat)

GblBool	GblScanner_peekLines (GblScanner *pSelf, size_t count)

GblBool	GblScanner_peekBytes (GblScanner *pSelf, size_t count)

GblBool	GblScanner_peekBool (GblScanner pSelf, GblBool pBool)

GblBool	GblScanner_peekChar (GblScanner pSelf, char pChar)

GblBool	GblScanner_peekUint8 (GblScanner pSelf, uint8_t pUint)

GblBool	GblScanner_peekUint16 (GblScanner pSelf, uint16_t pUint)

GblBool	GblScanner_peekInt16 (GblScanner pSelf, int16_t pInt)

GblBool	GblScanner_peekInt32 (GblScanner pSelf, int32_t pInt)

GblBool	GblScanner_peekUint32 (GblScanner pSelf, uint32_t pUint)

GblBool	GblScanner_peekInt64 (GblScanner pSelf, int64_t pInt)

GblBool	GblScanner_peekUint64 (GblScanner pSelf, uint64_t pUint)

GblBool	GblScanner_peekFloat (GblScanner pSelf, float pFloat)

GblBool	GblScanner_peekDouble (GblScanner pSelf, double pDouble)

GblBool	GblScanner_peekType (GblScanner *pSelf, GblType t,...)

GblBool	GblScanner_peekTypeVa (GblScanner pSelf, GblType t, va_list pVa)

#define	GblScanner_peek(self, ptr)

Skipping
Methods for skipping over the input steram
GblBool	GblScanner_skipTokens (GblScanner *pSelf, size_t count)

GblBool	GblScanner_skipMatch (GblScanner pSelf, const char pPattern)

GblBool	GblScanner_skipPattern (GblScanner pSelf, const GblPattern pPat)

GblBool	GblScanner_skipToMatch (GblScanner pSelf, const char pPattern)

GblBool	GblScanner_skipToPattern (GblScanner pSelf, const GblPattern pPat)

GblBool	GblScanner_skipLines (GblScanner *pSelf, size_t count)

GblBool	GblScanner_skipBytes (GblScanner *pSelf, size_t count)

Utilities
Methods providing other utilities
int	GblScanner_scanf (GblScanner pSelf, const char pFmt,...)

int	GblScanner_vscanf (GblScanner pSelf, const char pFmt, va_list *pList)

Related Symbols inherited from GblObject
GBL_RESULT	GblObject_property (const GblObject pSelf, const char pName,...)

GBL_RESULT	GblObject_propertyByQuark (const GblObject *pSelf, GblQuark name,...)

GBL_RESULT	GblObject_propertyVaList (const GblObject pSelf, const char pName, va_list *pList)

GBL_RESULT	GblObject_propertyVaByQuark (const GblObject pSelf, GblQuark name, va_list pList)

GBL_RESULT	GblObject_propertyVariant (const GblObject pSelf, const char pName, GblVariant *pValue)

GBL_RESULT	GblObject_propertyVariantByQuark (const GblObject pSelf, GblQuark name, GblVariant pValue)

GBL_RESULT	GblObject_properties (const GblObject *pSelf,...)

GBL_RESULT	GblObject_propertiesVa (const GblObject pSelf, va_list pList)

GBL_RESULT	GblObject_propertiesVariants (const GblObject pSelf, size_t count, const char pNames[], GblVariant *pValue)

GBL_RESULT	GblObject_setProperty (GblObject pSelf, const char pName,...)

GBL_RESULT	GblObject_setPropertyByQuark (GblObject *pSelf, GblQuark quark,...)

GBL_RESULT	GblObject_setPropertyVa (GblObject pSelf, const char pName, va_list *pList)

GBL_RESULT	GblObject_setPropertyVaListByQuark (GblObject pSelf, GblQuark name, va_list pList)

GBL_RESULT	GblObject_setPropertyVariant (GblObject pSelf, const char pName, GblVariant *pValue)

GBL_RESULT	GblObject_setPropertyVariantByQuark (GblObject pSelf, GblQuark name, GblVariant pValue)

GBL_RESULT	GblObject_setProperties (GblObject *pSelf,...)

GBL_RESULT	GblObject_setPropertiesVa (GblObject pSelf, va_list pList)

GBL_RESULT	GblObject_setPropertiesVariants (GblObject pSelf, size_t count, const char pNames[], GblVariant *pValue)

GBL_RESULT	GblObject_emitPropertyChange (const GblObject pSelf, const char pName)

GBL_RESULT	GblObject_emitPropertyChangeByQuark (const GblObject *pSelf, GblQuark name)

GblBool	GblObject_blockPropertyChange (GblObject *pSelf, GblBool blocked)

GblBool	GblObject_propertyChangeBlocked (const GblObject *pSelf)

GblBool	GblObject_isInstantiating (const GblObject *pSelf)

GblBool	GblObject_isConstructing (const GblObject *pSelf)

GblStringRef *	GblObject_name (const GblObject *pSelf)

void	GblObject_setName (GblObject pSelf, const char pName)

void	GblObject_setNameRef (GblObject pSelf, GblStringRef pRef)

GblObject *	GblObject_parent (const GblObject *pSelf)

void	GblObject_setParent (GblObject pSelf, GblObject pParent)

void	GblObject_addChild (GblObject pSelf, GblObject pChild)

GblBool	GblObject_removeChild (GblObject pSelf, GblObject pChild)

size_t	GblObject_depth (const GblObject *pSelf)

GblObject *	GblObject_childFirst (const GblObject *pSelf)

size_t	GblObject_childCount (const GblObject *pSelf)

size_t	GblObject_childIndex (const GblObject *pSelf)

GblObject *	GblObject_siblingNext (const GblObject *pSelf)

GblObject *	GblObject_siblingNextByType (const GblObject *pSelf, GblType type)

GblObject *	GblObject_siblingNextByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_siblingPrevious (const GblObject *pSelf)

GblObject *	GblObject_siblingPreviousByType (const GblObject *pSelf, GblType type)

GblObject *	GblObject_siblingPreviousByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findAncestorByType (const GblObject *pSelf, GblType ancestorType)

GblObject *	GblObject_findAncestorByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findAncestorByHeight (const GblObject *pSelf, size_t height)

GblObject *	GblObject_findBaseByDepth (const GblObject *pSelf, size_t depth)

GblObject *	GblObject_findChildByType (const GblObject *pSelf, GblType childType)

GblObject *	GblObject_findChildByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findChildByIndex (const GblObject *pSelf, size_t index)

GblObject *	GblObject_findSiblingByType (const GblObject *pSelf, GblType siblingType)

GblObject *	GblObject_findSiblingByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findSiblingByIndex (const GblObject *pSelf, size_t index)

GBL_RESULT	GblObject_sendEvent (GblObject pSelf, GblEvent pEvent)

GBL_RESULT	GblObject_notifyEvent (GblObject pSelf, GblEvent pEvent)

GBL_RESULT	GblObject_installEventFilter (GblObject pSelf, GblIEventReceiver pFilter)

GBL_RESULT	GblObject_uninstallEventFilter (GblObject pSelf, GblIEventReceiver pFilter)

size_t	GblObject_eventFilterCount (const GblObject *pSelf)

GblIEventReceiver *	GblObject_eventFilter (const GblObject *pSelf, size_t index)

Related Symbols inherited from GblInstance
#define	GBL_TYPEOF(self)

#define	GBL_PRIVATE(cType, self)

#define	GBL_PUBLIC(cType, selfPriv)

#define	GBL_TYPECHECK(cType, self)

#define	GBL_CAST(cType, self)

#define	GBL_AS(cType, self)

#define	GBL_CLASSOF(cType, self)

#define	GBL_CLASSOF_AS(cType, self)

#define	GBL_VCALL(cType, method, ...)

#define	GBL_VCALL_DEFAULT(cType, method, ...)

GblBool	GblInstance_check (const GblInstance *pSelf, GblType toType)

GblInstance *	GblInstance_cast (GblInstance *pSelf, GblType toType)

GblInstance *	GblInstance_as (GblInstance *pSelf, GblType toType)

void *	GblInstance_private (const GblInstance *pSelf, GblType base)

GblInstance *	GblInstance_public (const void *pPriv, GblType base)

GblType	GblInstance_typeOf (const GblInstance *pSelf)

size_t	GblInstance_size (const GblInstance *pSelf)

size_t	GblInstance_privateSize (const GblInstance *pSelf)

size_t	GblInstance_totalSize (const GblInstance *pSelf)

GblClass *	GblInstance_class (const GblInstance *pSelf)

GBL_RESULT	GblInstance_swizzleClass (GblInstance pSelf, GblClass pClass)

GBL_RESULT	GblInstance_sinkClass (GblInstance *pSelf)

GBL_RESULT	GblInstance_floatClass (GblInstance *pSelf)

Detailed Description

Generic text stream scanner object.

GblScanner offers a generic way to scan through a stream of text, parsing its contents into variables of any type supported by the type system.

See also: GblScannerClass

Definition at line 112 of file gimbal_scanner.h.

Friends And Related Symbol Documentation

◆ GblScanner_input()

GblStringRef * GblScanner_input ( const GblScanner * pSelf )

Returns a string reference to the string current being used as the input stream.

◆ GblScanner_setInput()

void GblScanner_setInput	(	GblScanner *	pSelf,
		const char *	pStr,
		size_t	count )

Sets the input stream to the given string, optionally taking its size, and resetting the stream.

◆ GblScanner_setInputRef()

void GblScanner_setInputRef	(	GblScanner *	pSelf,
		GblStringRef *	pRef )

Sets the input stream to given string reference, taking ownership of it, and resetting the sream.

◆ GblScanner_delimeters()

GblStringRef * GblScanner_delimeters ( const GblScanner * pSelf )

Returns a reference to the string used as the delimeter regular expression pattern.

◆ GblScanner_setDelimeters()

void GblScanner_setDelimeters	(	GblScanner *	pSelf,
		const char *	pPattern )

Sets the stream's delimeter regular expression pattern to pPattern.

◆ GblScanner_clearError()

void GblScanner_clearError ( GblScanner * pSelf )

Clears the pending error message string and any error flags which are set on the given scanner.

◆ GblScanner_raiseError()

void GblScanner_raiseError	(	GblScanner *	pSelf,
		GblFlags	flags,
		const char *	pFmt,
			... )

Raises an error, setting the given flags and message for the given scanner.

◆ GblScanner_reset()

void GblScanner_reset ( GblScanner * pSelf )

Resets the state of the input stream, moving the cursor back to the beginning.

◆ GblScanner_tell()

size_t GblScanner_tell ( const GblScanner * pSelf )

Fetches the current position of the cursor into the input stream.

◆ GblScanner_seek()

GblBool GblScanner_seek	(	GblScanner *	pSelf,
		int	whence )

Moves the cursor's current stream position by the given positive or negative offset.

◆ GblScanner_cursor()

const GblScannerCursor * GblScanner_cursor	(	const GblScanner *	pSelf,
		size_t	depth )

Returns the top cursor on the stack, which maintains the current position into the input stream.

◆ GblScanner_cursorDepth()

size_t GblScanner_cursorDepth ( const GblScanner * pSelf )

Returns the depth of the cursor stack for the given scanner object.

◆ GblScanner_pushCursor()

GBL_RESULT GblScanner_pushCursor ( GblScanner * pSelf )

Pushes the value of the current cursor onto the stack, saving its state.

◆ GblScanner_popCursor()

GBL_RESULT GblScanner_popCursor ( GblScanner * pSelf )

Pops the value of the current cursor from the top of the stack, reloading its state.

◆ GblScanner_scanToken()

GblBool GblScanner_scanToken ( GblScanner * pSelf )

Scans the next token, storing it to GblScanner::token or returning GBL_FALSE upon failure.

◆ GblScanner_scanMatch()

GblBool GblScanner_scanMatch	(	GblScanner *	pSelf,
		const char *	pPat )

Scans the next token to GblScanner::token if it matches the given pattern or returning GBL_FALSE upon failure.

◆ GblScanner_scanPattern()

GblBool GblScanner_scanPattern	(	GblScanner *	pSelf,
		const GblPattern *	pPat )

Todo: implement me: GblScanner_scanMatch() overload

◆ GblScanner_scanLines()

GblBool GblScanner_scanLines	(	GblScanner *	pSelf,
		size_t	lines )

Scans the given number of lines to GblScanner::token or returns GBL_FALSE upon failure.

◆ GblScanner_scanBytes()

GblBool GblScanner_scanBytes	(	GblScanner *	pSelf,
		size_t	bytes )

Scans the given number of bytes to GblScanner::token or returns GBL_FALSE upon failure.

◆ GblScanner_scanBool()

GblBool GblScanner_scanBool	(	GblScanner *	pSelf,
		GblBool *	pBool )

Scans the next token as a boolean to GblScanner::token, returning GBL_TRUE and setting pBool to the scanned value upon success.

◆ GblScanner_scanChar()

GblBool GblScanner_scanChar	(	GblScanner *	pSelf,
		char *	pChar )

Scans the next token as a character to GblScanner::token, returning GBL_TRUE and setting pChar to the scanned value upon success.

◆ GblScanner_scanUint8()

GblBool GblScanner_scanUint8	(	GblScanner *	pSelf,
		uint8_t *	pUint )

Scans the next token as an 8-bit unsigned integer to GblScanner::token, returning GBL_TRUE and setting pUint to the scanned value upon success.

◆ GblScanner_scanUint16()

GblBool GblScanner_scanUint16	(	GblScanner *	pSelf,
		uint16_t *	pUint )

Scans the next token as a 16-bit unsigned integer to GblScanner::token, returning GBL_TRUE and setting pUint to the scanned value upon success.

◆ GblScanner_scanInt16()

GblBool GblScanner_scanInt16	(	GblScanner *	pSelf,
		int16_t *	pInt )

Scans the next token as a 16-bit integer to GblScanner::token, returning GBL_TRUE and setting pInt to the scanned value upon success.

◆ GblScanner_scanInt32()

GblBool GblScanner_scanInt32	(	GblScanner *	pSelf,
		int32_t *	pInt )

Scans the next token as a 32-bit integer to GblScanner::token, returning GBL_TRUE and setting pInt to the scanned value upon success.

◆ GblScanner_scanUint32()

GblBool GblScanner_scanUint32	(	GblScanner *	pSelf,
		uint32_t *	pUint )

Scans the next token as a 32-bit unsigned integer to GblScanner::token, returning GBL_TRUE and setting pUint to the scanned value upon success.

◆ GblScanner_scanInt64()

GblBool GblScanner_scanInt64	(	GblScanner *	pSelf,
		int64_t *	pInt )

Scans the next token as a 64-bit integer to GblScanner::token, returning GBL_TRUE and setting pInt to the scanned value upon success.

◆ GblScanner_scanUint64()

GblBool GblScanner_scanUint64	(	GblScanner *	pSelf,
		uint64_t *	pUint )

Scans the next token as a 64-bit unsigned integer to GblScanner::token, returning GBL_TRUE and setting pUint to the scanned value upon success.

◆ GblScanner_scanFloat()

GblBool GblScanner_scanFloat	(	GblScanner *	pSelf,
		float *	pFloat )

Scans the next token as a float to GblScanner::token, returning GBL_TRUE and setting pFloat to the scanned value upon success.

◆ GblScanner_scanDouble()

GblBool GblScanner_scanDouble	(	GblScanner *	pSelf,
		double *	pDouble )

Scans the next token as a double to GblScanner::token, returning GBL_TRUE and setting pDouble to the scanned value upon success.

◆ GblScanner_scanType()

GblBool GblScanner_scanType	(	GblScanner *	pSelf,
		GblType	t,
			... )

Scans the next token and attempts to convert it from a string to the given type, t, moving its value through the variadic argument list.

◆ GblScanner_scanTypeVa()

GblBool GblScanner_scanTypeVa	(	GblScanner *	pSelf,
		GblType	t,
		va_list *	pVa )

Same as GblScanner_scanType(), except taking a va_list* rather than (a) variadic argument(s)

◆ GblScanner_scan

#define GblScanner_scan	(		self,
			ptr )

Generic overload macro which automatically calls the respective scan function for the type of ptr.

Definition at line 271 of file gimbal_scanner.h.

271#define GblScanner_scan(self, ptr) \

272 GBL_META_GENERIC_MACRO_GENERATE(GBL_SCANNER_SCAN_TABLE_, ptr)(self, ptr)

◆ GblScanner_peekToken()

GblBool GblScanner_peekToken ( GblScanner * pSelf )

Peeks at the next token, without advancing the stream, storing it to GblScanner::next or returning GBL_FALSE upon failure.

◆ GblScanner_peekMatch()

GblBool GblScanner_peekMatch	(	GblScanner *	pSelf,
		const char *	pMatch )

Peeks at the next token, storing it to GblScanner::next if it exactly matches the given pattern or returning GBL_FALSE upon failure.

◆ GblScanner_peekPattern()

GblBool GblScanner_peekPattern	(	GblScanner *	pSelf,
		const GblPattern *	pPat )

Todo: implement me: GblScanner_peekMatch() overload

◆ GblScanner_peekLines()

GblBool GblScanner_peekLines	(	GblScanner *	pSelf,
		size_t	count )

Peeks at the next count lines, storing them to GblScanner::next or returning GBL_FALSE upon encountering EOF.

◆ GblScanner_peekBytes()

GblBool GblScanner_peekBytes	(	GblScanner *	pSelf,
		size_t	count )

Peeks at the next count bytes, storing them to GblScanner::next or returning GBL_FALSE upon encountering EOF.

◆ GblScanner_peekBool()

GblBool GblScanner_peekBool	(	GblScanner *	pSelf,
		GblBool *	pBool )

Peeks at the next token, without advancing, setting pBool and returning GBL_TRUE if it's boolean-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekChar()

GblBool GblScanner_peekChar	(	GblScanner *	pSelf,
		char *	pChar )

Peeks at the next token, without advancing, setting pChar and returning GBL_TRUE if it's character-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekUint8()

GblBool GblScanner_peekUint8	(	GblScanner *	pSelf,
		uint8_t *	pUint )

Peeks at the next token, without advancing, setting pUint and returning GBL_TRUE if it's uint8-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekUint16()

GblBool GblScanner_peekUint16	(	GblScanner *	pSelf,
		uint16_t *	pUint )

Peeks at the next token, without advancing, setting pUint and returning GBL_TRUE if it's uint16-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekInt16()

GblBool GblScanner_peekInt16	(	GblScanner *	pSelf,
		int16_t *	pInt )

Peeks at the next token, without advancing, setting pInt and returning GBL_TRUE if it's int16-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekInt32()

GblBool GblScanner_peekInt32	(	GblScanner *	pSelf,
		int32_t *	pInt )

Peeks at the next token, without advancing, setting pInt and returning GBL_TRUE if it's int32-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekUint32()

GblBool GblScanner_peekUint32	(	GblScanner *	pSelf,
		uint32_t *	pUint )

Peeks at the next token, without advancing, setting pUint and returning GBL_TRUE if it's uint32-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekInt64()

GblBool GblScanner_peekInt64	(	GblScanner *	pSelf,
		int64_t *	pInt )

Peeks at the next token, without advancing, setting pInt and returning GBL_TRUE if it's int64-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekUint64()

GblBool GblScanner_peekUint64	(	GblScanner *	pSelf,
		uint64_t *	pUint )

Peeks at the next token, without advancing, setting pUint and returning GBL_TRUE if it's uint64-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekFloat()

GblBool GblScanner_peekFloat	(	GblScanner *	pSelf,
		float *	pFloat )

Peeks at the next token, without advancing, setting pFloat and returning GBL_TRUE if it's float-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekDouble()

GblBool GblScanner_peekDouble	(	GblScanner *	pSelf,
		double *	pDouble )

Peeks at the next token, without advancing, setting pDouble and returning GBL_TRUE if it's double-convertible, or returning GBL_FALSE otherwise.

◆ GblScanner_peekType()

GblBool GblScanner_peekType	(	GblScanner *	pSelf,
		GblType	t,
			... )

Peeks at the next token, without advancing, attempting to convert it to the given variant type, moving its value to the variadic argument, returning GBL_TRUE upon success.

◆ GblScanner_peekTypeVa()

GblBool GblScanner_peekTypeVa	(	GblScanner *	pSelf,
		GblType	t,
		va_list *	pVa )

Same as GblScanner_peekType(), except taking a va_list* rather than (a) variadic argument(s)

◆ GblScanner_peek

#define GblScanner_peek	(		self,
			ptr )

Generic overload macro which automatically calls the respective peek function for the type of ptr.

Definition at line 317 of file gimbal_scanner.h.

317#define GblScanner_peek(self, ptr) \

318 GBL_META_GENERIC_MACRO_GENERATE(GBL_SCANNER_PEEK_TABLE_, ptr)(self, ptr)

◆ GblScanner_skipTokens()

GblBool GblScanner_skipTokens	(	GblScanner *	pSelf,
		size_t	count )

Attempts to skip the next count tokens from the stream, returning GBL_TRUE upon success or GBL_FALSE upon EOF.

◆ GblScanner_skipMatch()

GblBool GblScanner_skipMatch	(	GblScanner *	pSelf,
		const char *	pPattern )

Attempts to skip to just past the given regex pPattern, returning GBL_TRUE upon success or GBL_FALSE if not found or upon EOF.

◆ GblScanner_skipPattern()

GblBool GblScanner_skipPattern	(	GblScanner *	pSelf,
		const GblPattern *	pPat )

Todo: implement me: GblScanner_skipMatch() overload

◆ GblScanner_skipToMatch()

GblBool GblScanner_skipToMatch	(	GblScanner *	pSelf,
		const char *	pPattern )

Attemps to skip to the matching regex pPattern, returning GBL_TRUE upon success or GBL_FALSE if not found or upon EOF.

◆ GblScanner_skipToPattern()

GblBool GblScanner_skipToPattern	(	GblScanner *	pSelf,
		const GblPattern *	pPat )

Todo: implement me: GblScanner_skipToMatch() overload

◆ GblScanner_skipLines()

GblBool GblScanner_skipLines	(	GblScanner *	pSelf,
		size_t	count )

Attempts to skip count lines, returning GBL_TRUE upon success or GBL_FALSE upon EOF.

◆ GblScanner_skipBytes()

GblBool GblScanner_skipBytes	(	GblScanner *	pSelf,
		size_t	count )

Attempts to skip count bytes, returning GBL_TRUE upon success or GBL_FALSE upon EOF.

◆ GblScanner_scanf()

int GblScanner_scanf	(	GblScanner *	pSelf,
		const char *	pFmt,
			... )

Invokes the C stdlib routine, sscanf(), at the current position of the input stream.

◆ GblScanner_vscanf()

int GblScanner_vscanf	(	GblScanner *	pSelf,
		const char *	pFmt,
		va_list *	pList )

Invokes the C stdlib routine, vscanf(), at the current position of the input stream.

Field Documentation

◆ pClass

GblScannerClass* GblScanner::pClass

Pointer to class/vtable structure.

Definition at line 112 of file gimbal_scanner.h.

◆ base

GblObject GblScanner::base

Inherited base instance structure.

Definition at line 112 of file gimbal_scanner.h.

◆ token

GblStringView GblScanner::token

Current token in the stream.

Definition at line 113 of file gimbal_scanner.h.

◆ next

GblStringView GblScanner::next

Peeked-at next token in the stream.

Definition at line 114 of file gimbal_scanner.h.

◆ pError

GblStringRef* GblScanner::pError

Pending error message.

Definition at line 115 of file gimbal_scanner.h.

◆ status

GBL_SCANNER_FLAGS GblScanner::status

Status after the last operation.

Definition at line 116 of file gimbal_scanner.h.

The documentation for this struct was generated from the following file:

gimbal_scanner.h

Data Fields

Related Symbols

Detailed Description

Friends And Related Symbol Documentation

◆ GblScanner_input()

◆ GblScanner_setInput()

◆ GblScanner_setInputRef()

◆ GblScanner_delimeters()

◆ GblScanner_setDelimeters()

◆ GblScanner_clearError()

◆ GblScanner_raiseError()

◆ GblScanner_reset()

◆ GblScanner_tell()

◆ GblScanner_seek()

◆ GblScanner_cursor()

◆ GblScanner_cursorDepth()

◆ GblScanner_pushCursor()

◆ GblScanner_popCursor()

◆ GblScanner_scanToken()

◆ GblScanner_scanMatch()

◆ GblScanner_scanPattern()

◆ GblScanner_scanLines()

◆ GblScanner_scanBytes()

◆ GblScanner_scanBool()

◆ GblScanner_scanChar()

◆ GblScanner_scanUint8()

◆ GblScanner_scanUint16()

◆ GblScanner_scanInt16()

◆ GblScanner_scanInt32()

◆ GblScanner_scanUint32()

◆ GblScanner_scanInt64()

◆ GblScanner_scanUint64()

◆ GblScanner_scanFloat()

◆ GblScanner_scanDouble()

◆ GblScanner_scanType()

◆ GblScanner_scanTypeVa()

◆ GblScanner_scan

◆ GblScanner_peekToken()

◆ GblScanner_peekMatch()

◆ GblScanner_peekPattern()

◆ GblScanner_peekLines()

◆ GblScanner_peekBytes()

◆ GblScanner_peekBool()

◆ GblScanner_peekChar()

◆ GblScanner_peekUint8()

◆ GblScanner_peekUint16()

◆ GblScanner_peekInt16()

◆ GblScanner_peekInt32()

◆ GblScanner_peekUint32()

◆ GblScanner_peekInt64()

◆ GblScanner_peekUint64()

◆ GblScanner_peekFloat()

◆ GblScanner_peekDouble()

◆ GblScanner_peekType()

◆ GblScanner_peekTypeVa()

◆ GblScanner_peek

◆ GblScanner_skipTokens()

◆ GblScanner_skipMatch()

◆ GblScanner_skipPattern()

◆ GblScanner_skipToMatch()

◆ GblScanner_skipToPattern()

◆ GblScanner_skipLines()

◆ GblScanner_skipBytes()

◆ GblScanner_scanf()

◆ GblScanner_vscanf()

Field Documentation

◆ pClass

◆ base

◆ token

◆ next

◆ pError

◆ status