A smart class to hold the text for parsing. More...

#include <sourcetext.h>

Collaboration diagram for SourceText:

Public Member Functions
	SourceText ()
	Default constructor. More...

void	AppendFile (const String &name)
	Appends contents of file to the source text. More...

char	Current ()
	Return the current character. More...

bool	reachedEot ()
	Check if the current position reached the end. More...

void	AdvanceChar ()
	Advance position pointer by one character. More...

void	AdvanceLine ()
	Advances position pointer by one line. More...

const String &	File ()
	Return the filename associated with the current position. More...

Index	Line ()
	Return the line number, but for the file that is associated with the current position. More...

Index	LineRaw ()
	Return the line index. More...

Index	ColumnRaw ()
	Return the column index. More...

Index	Column ()
	Return the current column. More...

void	SetPosition (Index line, Index column)
	Set current position. More...

void	Init ()
	This sets the pointer to the first existing character in the text. More...

bool &	LineBreak ()
	Read the line break flag. More...

bool	LineBreak () const
	Const version of LineBreak. More...

Private Attributes
ArrayOfString	mText
	The text. More...

Index	mLine
	Line position in the text. More...

Index	mColumn
	Column position in the text. More...

ArrayOfIndex	mSfLine
	Remember where which source file starts. More...

ArrayOfString	mSfName
	Names associated with. More...

bool	mLineBreak
	Is set to true if the last operation caused a line break. More...

Friends
std::ostream &	operator<< (std::ostream &os, const SourceText &text)
	Output operator for SourceText. More...

Detailed Description

A smart class to hold the text for parsing.

A variable of this class can hold not only the text of the ARTS Control file, but also a position in the text. This is handy for parsing. There is also a function to return the current character and functions to advance the position. (AdvanceChar advances the position to the next character, doing a line break if necessary; AdvanceLine goes to the next line.)

mLine and mColumn are 0 based, but Line and Column are 1 based.

Author: Stefan Buehler

Definition at line 37 of file sourcetext.h.

Constructor & Destructor Documentation

◆ SourceText()

SourceText::SourceText ( )

inline

Default constructor.

Definition at line 41 of file sourcetext.h.

References AppendFile().

Member Function Documentation

◆ AdvanceChar()

void SourceText::AdvanceChar ( )

Advance position pointer by one character.

Sets mLineBreak if a line break occured.

Exceptions

Eot	The end of text is reached.

Definition at line 32 of file sourcetext.cc.

References Column(), File(), Line(), mColumn, mLine, mLineBreak, mText, and Array< base >::nelem().

Referenced by ArtsParser::assertain_character(), ArtsParser::eat_whitespace(), ArtsParser::find_named_arguments(), ArtsParser::parse_intvector(), ArtsParser::parse_matrix(), ArtsParser::parse_method(), ArtsParser::parse_method_args(), ArtsParser::parse_numvector(), ArtsParser::parse_String(), ArtsParser::parse_Stringvector(), reachedEot(), ArtsParser::read_integer(), ArtsParser::read_name(), ArtsParser::read_numeric(), and ArtsParser::skip_to_next_argument().

◆ AdvanceLine()

void SourceText::AdvanceLine ( )

Advances position pointer by one line.

Exceptions

Eot	The end of the text is reached.

Definition at line 66 of file sourcetext.cc.

References Column(), File(), Line(), mColumn, mLine, mLineBreak, mText, and Array< base >::nelem().

Referenced by ArtsParser::eat_whitespace(), and reachedEot().

◆ AppendFile()

void SourceText::AppendFile ( const String & name )

Appends contents of file to the source text.

See also: read_text_from_file

Definition at line 23 of file sourcetext.cc.

References mSfLine, mSfName, mText, Array< base >::nelem(), and read_text_from_file().

Referenced by ArtsParser::ArtsParser(), and SourceText().

◆ Column()

Index SourceText::Column ( )

inline

◆ ColumnRaw()

Index SourceText::ColumnRaw ( )

inline

Return the column index.

Definition at line 84 of file sourcetext.h.

References mColumn.

Referenced by ArtsParser::find_named_arguments(), ArtsParser::parse_method_args(), and ArtsParser::skip_to_next_argument().

◆ Current()

char SourceText::Current ( )

inline

◆ File()

const String & SourceText::File ( )

Return the filename associated with the current position.

Definition at line 88 of file sourcetext.cc.

References mLine, mSfLine, mSfName, and Array< base >::nelem().

◆ Init()

void SourceText::Init ( )

This sets the pointer to the first existing character in the text.

(First few lines could be empty).

Definition at line 118 of file sourcetext.cc.

References Column(), File(), Line(), mColumn, mLine, mLineBreak, mText, and Array< base >::nelem().

Referenced by ArtsParser::parse_main(), and SetPosition().

◆ Line()

Index SourceText::Line ( )

Return the line number, but for the file that is associated with the current position.

Definition at line 103 of file sourcetext.cc.

References mLine, mSfLine, and Array< base >::nelem().

◆ LineBreak() [1/2]

bool& SourceText::LineBreak ( )

inline

Read the line break flag.

Set this to false before an operation that you want to monitor and check it afterwards.

Definition at line 102 of file sourcetext.h.

References mLineBreak.

Referenced by ArtsParser::parse_String(), ArtsParser::read_integer(), ArtsParser::read_name(), and ArtsParser::read_numeric().

◆ LineBreak() [2/2]

bool SourceText::LineBreak ( ) const

inline

Const version of LineBreak.

See also: LineBreak

Definition at line 106 of file sourcetext.h.

References mLineBreak, and operator<<.

◆ LineRaw()

Index SourceText::LineRaw ( )

inline

Return the line index.

Definition at line 81 of file sourcetext.h.

References mLine.

Referenced by ArtsParser::find_named_arguments(), ArtsParser::parse_method_args(), and ArtsParser::skip_to_next_argument().

◆ reachedEot()

bool SourceText::reachedEot ( )

inline

Check if the current position reached the end.

Definition at line 57 of file sourcetext.h.

References AdvanceChar(), AdvanceLine(), File(), Line(), mColumn, mLine, mText, and Array< base >::nelem().

Referenced by Current(), and ArtsParser::parse_main().

◆ SetPosition()

void SourceText::SetPosition	(	Index	line,
		Index	column
	)

inline

Set current position.

Definition at line 90 of file sourcetext.h.

References Init(), mColumn, and mLine.

Referenced by ArtsParser::parse_generic_input(), ArtsParser::parse_generic_output(), ArtsParser::parse_method_args(), ArtsParser::parse_specific_input(), ArtsParser::parse_specific_output(), and ArtsParser::skip_to_next_argument().

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const SourceText &	text
	)

friend

Output operator for SourceText.

(Only used for debugging)

Definition at line 152 of file sourcetext.cc.

Referenced by LineBreak().

Member Data Documentation

◆ mColumn

Index SourceText::mColumn

private

Column position in the text.

(0 based!)

Definition at line 120 of file sourcetext.h.

Referenced by AdvanceChar(), AdvanceLine(), Column(), ColumnRaw(), Current(), Init(), reachedEot(), and SetPosition().

◆ mLine

Index SourceText::mLine

private

Line position in the text.

(0 based!)

Definition at line 117 of file sourcetext.h.

Referenced by AdvanceChar(), AdvanceLine(), Current(), File(), Init(), Line(), LineRaw(), reachedEot(), and SetPosition().

◆ mLineBreak

bool SourceText::mLineBreak

private

Is set to true if the last operation caused a line break.

Has to be cleared explicitly!

Definition at line 130 of file sourcetext.h.

Referenced by AdvanceChar(), AdvanceLine(), Init(), and LineBreak().

◆ mSfLine

ArrayOfIndex SourceText::mSfLine

private

Remember where which source file starts.

Definition at line 123 of file sourcetext.h.

Referenced by AppendFile(), File(), and Line().

◆ mSfName

ArrayOfString SourceText::mSfName

private

Names associated with.

See also: mSfLine.

Definition at line 126 of file sourcetext.h.

Referenced by AppendFile(), and File().

◆ mText

ArrayOfString SourceText::mText

private

The text.

Definition at line 114 of file sourcetext.h.

Referenced by AdvanceChar(), AdvanceLine(), AppendFile(), Current(), Init(), operator<<(), and reachedEot().

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

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SourceText()

Member Function Documentation

◆ AdvanceChar()

◆ AdvanceLine()

◆ AppendFile()

◆ Column()

◆ ColumnRaw()

◆ Current()

◆ File()

◆ Init()

◆ Line()

◆ LineBreak() [1/2]

◆ LineBreak() [2/2]

◆ LineRaw()

◆ reachedEot()

◆ SetPosition()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ mColumn

◆ mLine

◆ mLineBreak

◆ mSfLine

◆ mSfName

◆ mText