castor::PreprocessedFile Class Reference

#include <FileParser.hpp>

Collaboration diagram for castor::PreprocessedFile:

Classes
struct	Action

Public Types
using	ActionFunc = castor::Function< void( SectionId, Action const & ) >
using	ActionSignal = SignalT< ActionFunc >
using	ActionConnection = ConnectionT< ActionSignal >

Public Member Functions
CU_API	PreprocessedFile (PreprocessedFile const &rhs)=delete
CU_API PreprocessedFile &	operator= (PreprocessedFile const &rhs)=delete
CU_API	PreprocessedFile (PreprocessedFile &&rhs) noexcept
CU_API PreprocessedFile &	operator= (PreprocessedFile &&rhs) noexcept
virtual CU_API	~PreprocessedFile () noexcept=default
CU_API	PreprocessedFile (FileParser &parser)
CU_API	PreprocessedFile (FileParser &parser, FileParserContextUPtr context)
CU_API void	addParserAction (Path file, uint64_t line, String name, SectionId section, ParserFunctionAndParams function, String params, bool implicit)
CU_API bool	parse ()
CU_API void	parseError (String const &error)
CU_API void	parseWarning (String const &warning)
FileParserContext &	getContext () const
uint32_t	getCount () const

Public Attributes
ActionSignal	onAction

Protected Member Functions
virtual CU_API bool	doIsEmpty () const
virtual CU_API void	doAddParserAction (Path file, uint64_t line, String name, SectionId section, ParserFunctionAndParams function, String params, bool implicit)
virtual CU_API Action *	doGetFirstAction ()
virtual CU_API Action *	doGetNextAction ()

Protected Attributes
FileParser &	m_parser
FileParserContextUPtr	m_context
Vector< Action >	m_actions
Vector< Action >::iterator	m_current
Action	m_popAction

Member Typedef Documentation

ActionConnection

using castor::PreprocessedFile::ActionConnection = ConnectionT< ActionSignal >

ActionFunc

using castor::PreprocessedFile::ActionFunc = castor::Function< void( SectionId, Action const & ) >

ActionSignal

using castor::PreprocessedFile::ActionSignal = SignalT< ActionFunc >

Constructor & Destructor Documentation

PreprocessedFile() [1/4]

CU_API castor::PreprocessedFile::PreprocessedFile ( PreprocessedFile const & rhs )

delete

PreprocessedFile() [2/4]

CU_API castor::PreprocessedFile::PreprocessedFile ( PreprocessedFile && rhs )

noexcept

~PreprocessedFile()

virtual CU_API castor::PreprocessedFile::~PreprocessedFile ( )

virtualdefaultnoexcept

PreprocessedFile() [3/4]

CU_API castor::PreprocessedFile::PreprocessedFile ( FileParser & parser )

explicit

PreprocessedFile() [4/4]

CU_API castor::PreprocessedFile::PreprocessedFile	(	FileParser &	parser,
		FileParserContextUPtr	context )

Member Function Documentation

addParserAction()

CU_API void castor::PreprocessedFile::addParserAction	(	Path	file,
		uint64_t	line,
		String	name,
		SectionId	section,
		ParserFunctionAndParams	function,
		String	params,
		bool	implicit )

doAddParserAction()

virtual CU_API void castor::PreprocessedFile::doAddParserAction ( Path file, uint64_t line, String name, SectionId section, ParserFunctionAndParams function, String params, bool implicit )

protectedvirtual

doGetFirstAction()

virtual CU_API Action * castor::PreprocessedFile::doGetFirstAction ( )

protectedvirtual

doGetNextAction()

virtual CU_API Action * castor::PreprocessedFile::doGetNextAction ( )

protectedvirtual

doIsEmpty()

virtual CU_API bool castor::PreprocessedFile::doIsEmpty ( ) const

protectedvirtual

getContext()

FileParserContext & castor::PreprocessedFile::getContext ( ) const

inline

References m_context.

getCount()

uint32_t castor::PreprocessedFile::getCount ( ) const

inline

References m_actions.

operator=() [1/2]

CU_API PreprocessedFile & castor::PreprocessedFile::operator= ( PreprocessedFile && rhs )

noexcept

operator=() [2/2]

CU_API PreprocessedFile & castor::PreprocessedFile::operator= ( PreprocessedFile const & rhs )

delete

parse()

CU_API bool castor::PreprocessedFile::parse

(

)

parseError()

CU_API void castor::PreprocessedFile::parseError

(

String const &

error

)

parseWarning()

CU_API void castor::PreprocessedFile::parseWarning

(

String const &

warning

)

Member Data Documentation

m_actions

Vector< Action > castor::PreprocessedFile::m_actions

protected

Referenced by getCount().

m_context

FileParserContextUPtr castor::PreprocessedFile::m_context

protected

Referenced by getContext().

m_current

Vector<Action>::iterator castor::PreprocessedFile::m_current

protected

m_parser

FileParser& castor::PreprocessedFile::m_parser

protected

m_popAction

Action castor::PreprocessedFile::m_popAction

protected

onAction

ActionSignal castor::PreprocessedFile::onAction

---

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

• CastorUtils/FileParser/FileParser.hpp