Construct Token list from a stream. More...

#include <PvlTokenizer.h>

Collaboration diagram for Isis::PvlTokenizer:

Public Member Functions
	PvlTokenizer ()
	Constructs a Tokenizer with an empty token list.

	~PvlTokenizer ()
	Destroys the Tokenizer object and token list.

void	Load (std::istream &stream, const QString &terminator="END")
	Loads the Token list from a stream.

void	Clear ()
	Empties the token list.

std::vector< Isis::PvlToken > &	GetTokenList ()

Protected Member Functions
QString	ReadComment (std::istream &stream)
	Reads and returns a comment from the stream.

QString	ReadToken (std::istream &stream)
	Reads and returns a token from the stream.

bool	SkipWhiteSpace (std::istream &stream)
	Skips over whitespace so long as it is not inside quotes.

QString	ReadToSingleQuote (std::istream &stream)

QString	ReadToDoubleQuote (std::istream &stream)

QString	ReadToParen (std::istream &stream)

QString	ReadToBrace (std::istream &stream)

void	ParseCommaList (Isis::PvlToken &t, const QString &cl)
	This routine parses a QString containing a comma separated list.

void	ValidateCharacter (int c)
	Make sure a character is valid printable (non-control) character.

Protected Attributes
std::vector< Isis::PvlToken >	tokens
	The array of Tokens parse out of the stream.

Detailed Description

Construct Token list from a stream.

This class tokenizes a stream. That is, it will take a stream, from a file or a string, and break the contents of the stream into keyword-value pairs. Examples of such are PDS labels, the standard Isis command line, and VICAR labels. Note that this does not validate the stream to ensure it is of PDS- or VICAR-type. It simply creates a list of keyword-value pairs which can be parsed by another object. The ruleset for tokenizing is straightforward. Consider SPACECRAFT=MARS_GLOBAL_SURVEYOR. The keyword would be SPACECRAFT and the value would be MARS_GLOBAL_SURVEYOR. Other valid examples include: LINES=5, FOCAL_LENGTH=12.4, INSTRUMENT="CAMERA_A", LIST=(0,1,5), and DOGS=("LAB","PUG","BULL"). The later examples, are considered arrays and therefore, will have multiple values associated with the keyword. Comments are allowed in the stream and are indicated by either "#" or "/ *" as the first character on the line.

Author: 2002-02-15 Jeff Anderson

Constructor & Destructor Documentation

◆ PvlTokenizer()

Isis::PvlTokenizer::PvlTokenizer ( )

Constructs a Tokenizer with an empty token list.

References Clear().

◆ ~PvlTokenizer()

Isis::PvlTokenizer::~PvlTokenizer ( )

Destroys the Tokenizer object and token list.

References Clear().

Member Function Documentation

◆ Clear()

void Isis::PvlTokenizer::Clear ( )

Empties the token list.

References tokens.

Referenced by PvlTokenizer(), and ~PvlTokenizer().

◆ GetTokenList()

vector< Isis::PvlToken > & Isis::PvlTokenizer::GetTokenList ( )

References tokens.

◆ Load()

void Isis::PvlTokenizer::Load	(	std::istream &	stream,
		const QString &	terminator = "END" )

Loads the Token list from a stream.

The loading will be terminated upon reaching either 1) end-of-stream, or 2) a programmer specified terminator QString

Parameters

stream	The input stream to tokenize
terminator	If the tokenizer see's this QString as a token in the input stream it will cease tokenizing. Defaults to "END"

Exceptions

Isis::iException::Parse

References _FILEINFO_, Isis::Message::KeywordValueBad(), ParseCommaList(), ReadComment(), ReadToBrace(), ReadToDoubleQuote(), ReadToken(), ReadToParen(), ReadToSingleQuote(), SkipWhiteSpace(), tokens, Isis::IException::Unknown, and ValidateCharacter().

◆ ParseCommaList()

void Isis::PvlTokenizer::ParseCommaList	(	Isis::PvlToken &	t,
		const QString &	cl )

protected

This routine parses a QString containing a comma separated list.

Each of the items in the list is stored as a value in the Token.

Parameters

t	Token to load the comma separated list
cl	QString containing comma separated list

References ReadToBrace(), ReadToDoubleQuote(), ReadToParen(), ReadToSingleQuote(), and SkipWhiteSpace().

Referenced by Load().

◆ ReadComment()

QString Isis::PvlTokenizer::ReadComment ( std::istream & stream )

protected

Reads and returns a comment from the stream.

Parameters

stream Input stream to read from

Returns: QString

References ValidateCharacter().

Referenced by Load().

◆ ReadToBrace()

QString Isis::PvlTokenizer::ReadToBrace ( std::istream & stream )

protected

References _FILEINFO_, Isis::Message::MissingDelimiter(), ReadToDoubleQuote(), ReadToSingleQuote(), Isis::IException::Unknown, and ValidateCharacter().

Referenced by Load(), and ParseCommaList().

◆ ReadToDoubleQuote()

QString Isis::PvlTokenizer::ReadToDoubleQuote ( std::istream & stream )

protected

References _FILEINFO_, Isis::Message::MissingDelimiter(), Isis::IException::Unknown, and ValidateCharacter().

Referenced by Load(), ParseCommaList(), ReadToBrace(), and ReadToParen().

◆ ReadToken()

QString Isis::PvlTokenizer::ReadToken ( std::istream & stream )

protected

Reads and returns a token from the stream.

A token is delimited by either whitespace or an equal sign. In the case of whitespace the token will be considered valueless. That is, there will be no value in the value side of the token (e.g., KEYWORD=).

Parameters

stream Input stream to read from