SourceMod::ITextListener_SMC Class Reference

Describes the events available for reading an SMC stream. More...

#include <public/ITextParsers.h>

List of all members.

Public Member Functions
virtual unsigned int	GetTextParserVersion2 ()
	Returns version number.
virtual void	ReadSMC_ParseStart ()
	Called when starting parsing.
virtual void	ReadSMC_ParseEnd (bool halted, bool failed)
	Called when ending parsing.
virtual SMCResult	ReadSMC_NewSection (const SMCStates *states, const char *name)
	Called when entering a new section.
virtual SMCResult	ReadSMC_KeyValue (const SMCStates *states, const char *key, const char *value)
	Called when encountering a key/value pair in a section.
virtual SMCResult	ReadSMC_LeavingSection (const SMCStates *states)
	Called when leaving the current section.
virtual SMCResult	ReadSMC_RawLine (const SMCStates *states, const char *line)
	Called after an input line has been preprocessed.

---

Detailed Description

Describes the events available for reading an SMC stream.

Definition at line 236 of file ITextParsers.h.

---

Member Function Documentation

virtual void SourceMod::ITextListener_SMC::ReadSMC_ParseEnd	(	bool	halted,
		bool	failed
	)			[inline, virtual]

Called when ending parsing.

Parameters:

	halted	True if abnormally halted, false otherwise.
	failed	True if parsing failed, false otherwise.

Definition at line 260 of file ITextParsers.h.

virtual SMCResult SourceMod::ITextListener_SMC::ReadSMC_NewSection	(	const SMCStates *	states,
		const char *	name
	)			[inline, virtual]

Called when entering a new section.

Parameters:

	states	Parsing states.
	name	Name of section, with the colon omitted.

Returns:

SMCResult directive.

Definition at line 271 of file ITextParsers.h.

virtual SMCResult SourceMod::ITextListener_SMC::ReadSMC_KeyValue	(	const SMCStates *	states,
		const char *	key,
		const char *	value
	)			[inline, virtual]

Called when encountering a key/value pair in a section.

Parameters:

	states	Parsing states.
	key	Key string.
	value	Value string. If no quotes were specified, this will be NULL, and key will contain the entire string.

Returns:

SMCResult directive.

Definition at line 285 of file ITextParsers.h.

virtual SMCResult SourceMod::ITextListener_SMC::ReadSMC_LeavingSection

(

const SMCStates *

states

)

[inline, virtual]

Called when leaving the current section.

Parameters:

states

Parsing states.

Returns:

SMCResult directive.

Definition at line 296 of file ITextParsers.h.

virtual SMCResult SourceMod::ITextListener_SMC::ReadSMC_RawLine	(	const SMCStates *	states,
		const char *	line
	)			[inline, virtual]

Called after an input line has been preprocessed.

Parameters:

	states	Parsing states.
	line	Contents of the line, null terminated at the position of the newline character (thus, no newline will exist).

Returns:

SMCResult directive.

Definition at line 309 of file ITextParsers.h.

---

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

• public/ITextParsers.h

---