ParserGroup Class Reference

Serialization node, which contains other groups to create a hierarchy or ParseEntries for data. More...

#include <parser_group.h>

Public Member Functions
	ParserGroup (const CoreString &name)
	Constructor.
	ParserGroup (const ParserGroup &group)
	Copy Constructor.
virtual	~ParserGroup ()
	Destructor.
ParserEntry *	add_entry (const CoreString &name, const unsigned long &line=0, const unsigned long &column=0)
	Adds a new entry.
ParserEntry *	add_entry (const ParserEntry &entry)
	Adds the specified entry to this group. More...
ParserGroup *	add_group (const CoreString &name)
	Adds a new group.
ParserGroup *	add_group (ParserGroup *group)
	Adds a group.
void	move_entry (const unsigned int &from, const unsigned int &to)
	Move an entry rank in the same group. More...
void	move_entry (const unsigned int &index, ParserGroup &group)
	Move an entry from its group to the specified one. More...
void	detach_entry (const unsigned int &index)
void	move_entries (ParserGroup &group)
	Move all entries into the specified group. More...
void	move_entries (ParserGroup &group, unsigned int index)
	Move all entries into the specified group. More...
void	remove_entry (const CoreString &name)
	remove the entries from this group More...
void	remove_entry (unsigned int index)
	remove the entry from the group at the given index More...
void	remove_entries (CoreBasicArray< unsigned int > indices)
	remove the entries from the group at the given indices More...
const CoreString &	get_name () const
unsigned int	get_entry_count () const
	Gets number of entries.
ParserEntry *	get_entry (const unsigned int &index) const
	Gets entry at specified index.
ParserEntry *	get_entry (const CoreString &entry_name) const
CoreVector< ParserEntry * >	get_entries (const CoreString &entry_name, bool recursive=false) const
	get all the entries in the group matching the given name More...
const CoreVector< ParserEntry * > &	get_entries () const
ParserEntry *	get_keyword (const CoreString &name) const
void	get_text (CoreString &text, const bool &with_header, const bool &multiline=true, const unsigned int &offset=1) const
bool	set_text (const CoreString &text, const CoreVersion &serial_version=default_parser_serial_version, AppProgressBar *progress_bar=0)
void	get_encrypted_text (CoreArray< unsigned char > &buffer, const CoreString &key, const bool &with_header, const bool &multiline=true, const unsigned int &offset=1) const
bool	set_encrypted_text (const CoreArray< unsigned char > &buffer, const CoreString &key)
void	get_encrypted_text (CoreString &text, const CoreString &key, const bool &with_header, const bool &multiline=true, const unsigned int &offset=1) const
bool	set_encrypted_text (const CoreString &text, const CoreString &key)
void	set_source_entry (ParserEntry *entry)
const ParserEntry *	get_source_entry () const
CoreVector< char >	get_binary (const bool &named) const
bool	set_binary (const CoreVector< char > &buffer, long unsigned long &position)
unsigned int	get_first_entry_index (ParserEntry::Type type)
void	set (const ParserGroup &group)
	Replace this by the group specified in parameter. The group name gets also renamed.
void	clear ()

Friends
struct	ParserImpl
CoreLogStream &	operator<< (CoreLogStream &stream, const ParserGroup &group)

Detailed Description

Serialization node, which contains other groups to create a hierarchy or ParseEntries for data.

Member Function Documentation

add_entry()

ParserEntry * ParserGroup::add_entry

(

const ParserEntry &

entry

)

Adds the specified entry to this group.

Note

This group will manage releasing.

Take care on usage : 'entry' parameter adress is stored for later usage.

get_entries()

CoreVector< ParserEntry * > ParserGroup::get_entries	(	const CoreString &	entry_name,
		bool	recursive = false
	)		const

get all the entries in the group matching the given name

Parameters

entry_name	the name of the entries to gather
recursive	if true, the entries in all the children groups matching the given name are also gathered

get_first_entry_index()

unsigned int ParserGroup::get_first_entry_index

(

ParserEntry::Type

type

)

Return the index of the first occurrence of the entry of the given type

move_entries() [1/2]

void ParserGroup::move_entries

(

ParserGroup &

group

)

Move all entries into the specified group.

Parameters

group

receiving the entries

move_entries() [2/2]

void ParserGroup::move_entries	(	ParserGroup &	group,
		unsigned int	index
	)

Move all entries into the specified group.

Parameters

group	receiving the entries
index	start index from which to insert the entries in group

move_entry() [1/2]

void ParserGroup::move_entry	(	const unsigned int &	from,
		const unsigned int &	to
	)

Move an entry rank in the same group.

Parameters

index	of the entry
new	index of the entry

move_entry() [2/2]

void ParserGroup::move_entry	(	const unsigned int &	index,
		ParserGroup &	group
	)

Move an entry from its group to the specified one.

Parameters

index	of the entry in this group
group	receiving the entry

remove_entries()

void ParserGroup::remove_entries

(

CoreBasicArray< unsigned int >

indices

)

remove the entries from the group at the given indices

Parameters

indices

the indices of the entries in the group

Note

the entries are deleted

remove_entry() [1/2]

void ParserGroup::remove_entry

(

const CoreString &

name

)

remove the entries from this group

Parameters

name	the name of the entries to remove

Note

the entries are deleted

remove_entry() [2/2]

void ParserGroup::remove_entry

(

unsigned int

index

)

remove the entry from the group at the given index

Parameters

index

the index of the entry in the group

Note

the entries are deleted