#include <parser.h>

Public Member Functions
	ArtsParser (Agenda &tasklist, String controlfile, const Verbosity &verbosity)
	Constructs a new parser.

void	parse_tasklist ()
	Public interface to the main function of the parser.

Private Types
using	NamedArgument = { String name

using	NamedArguments = vector< NamedArgument >

Private Member Functions
void	find_named_arguments (vector< NamedArgument > &named_args)
	Find named arguments.

void	skip_to_next_argument ()
	Skips forward to the next argument.

void	at_end_of_argument (const String &argname)
	Check if current position in controlfile is at the end of an argument.

void	get_argument_index_by_name (Index &arg_index, NamedArguments &named_args, const String &name)
	Return the index of the argument with the given name.

void	parse_main ()
	The main function of the parser.

void	parse_agenda (Agenda &tasklist, const String &agenda_name)
	Parse the Contents of text as ARTS control input.

void	parse_method (Index &id, ArrayOfIndex &output, ArrayOfIndex &input, Agenda &tasks, ArrayOfIndex &auto_vars, Array< TokVal > &auto_vars_values, String &include_file, bool no_eot=false)
	Parse the Contents of text as ARTS control input.

void	parse_generic_input (const MdRecord *&mdd, Index &id, String &methodname, ArrayOfIndex &input, ArrayOfIndex &auto_vars, Array< TokVal > &auto_vars_values, bool &first, bool &still_supergeneric, String &supergeneric_args, Index &supergeneric_index, NamedArguments &named_args, bool call_by_name)
	Parse the generic input WSVs for current method from the controlfile.

void	parse_generic_output (const MdRecord *&mdd, Index &id, String &methodname, ArrayOfIndex &output, bool &first, bool &still_supergeneric, String &supergeneric_args, Index &supergeneric_index, NamedArguments &named_args, bool call_by_name)
	Parse the generic output WSVs for current method from the controlfile.

void	parse_specific_input (const MdRecord *mdd, ArrayOfIndex &input, ArrayOfIndex &auto_vars, Array< TokVal > &auto_vars_values, bool &first, NamedArguments &named_args, bool call_by_name)
	Parse the specific input WSVs for current method from the controlfile.

void	parse_specific_output (const MdRecord *mdd, ArrayOfIndex &output, bool &first, NamedArguments &named_args, bool call_by_name)
	Parse the output WSVs for current method from the controlfile.

void	parse_method_args (const MdRecord *&mdd, Index &id, String &methodname, ArrayOfIndex &output, ArrayOfIndex &input, ArrayOfIndex &auto_vars, Array< TokVal > &auto_vars_values)
	Parse method's argument list.

void	use_default_method_args (const MdRecord *mdd, String &methodname, ArrayOfIndex &output, ArrayOfIndex &input, ArrayOfIndex &auto_vars, Array< TokVal > &auto_vars_values)
	Set defaults if method is called without any arguments.

String	set_gin_to_default (const MdRecord *mdd, ArrayOfIndex &auto_vars, Array< TokVal > &auto_vars_values, Index keyword_index)
	Set generic input to default value.

void	tasklist_insert_set_delete (const ArrayOfIndex &auto_vars, const Array< TokVal > &auto_vars_values, const Index method_type, Agenda &tasklist)
	Insert Set and Delete methods for automatically allocated output WSVs.

bool	is_whitespace (const char c)
	Returns true if this character is considered whitespace.

void	eat_whitespace ()
	Eats whitespace.

void	eat_whitespace_from_string (String &str, size_t &pos)
	Eats whitespace from a String.

void	read_name (String &name)
	Reads name of method, keyword, or workspace variable.

Index	read_name_or_value (String &name, ArrayOfIndex &auto_vars, Array< TokVal > &auto_vars_values, const String &default_name, const MdRecord *mdd, const Index group)
	Reads name of a workspace variable or a value.

void	assertain_character (char c)
	Make sure that the current character is equal to c and go to the next character.

void	parse_String (String &res)
	Reads a String, complete with quotation marks.

void	read_integer (String &res)
	Reads an integer.

void	read_numeric (String &res)
	Reads a floating point number.

void	parse_integer (Index &n)
	Use a String stream to parse an integer number.

void	parse_numeric (Numeric &n)
	Use a String stream to parse a floating point number.

void	parse_Stringvector (ArrayOfString &res)
	Read a vector of Strings.

void	parse_intvector (ArrayOfIndex &res)
	Read a vector of integers.

void	parse_numvector (Vector &res)
	Read a vector of Numerics.

void	parse_matrix (Matrix &res)
	Read a Matrix.

bool	parse_intvector_from_string (ArrayOfIndex &res, String &str)
	Read an array of integers from a String.

bool	parse_numvector_from_string (Vector &res, String &str)
	Read a vector of Numerics from a String.

bool	parse_stringarray_from_string (ArrayOfString &res, String &str)
	Read an Array of Strings from a String.

Private Attributes
Index	line

Index	column

Agenda &	mtasklist

std::shared_ptr< Workspace >	ws

String	mcfile

SourceText	msource

Index	mcfile_version

const Verbosity &	verbosity

Detailed Description

Definition at line 9 of file parser.h.

Member Typedef Documentation

◆ NamedArgument

using ArtsParser::NamedArgument = { String name

private

Definition at line 16 of file parser.h.

◆ NamedArguments

using ArtsParser::NamedArguments = vector<NamedArgument>

private

Definition at line 22 of file parser.h.

Constructor & Destructor Documentation

◆ ArtsParser()

ArtsParser::ArtsParser	(	Agenda &	tasklist,
		String	controlfile,
		const Verbosity &	rverbosity
	)

Constructs a new parser.

Parameters

[out]	tasklist	Method list read from the controlfile.
[in]	controlfile	Path to the controlfile.

Author: Oliver Lemke

Definition at line 22 of file parser.cc.

References SourceText::AppendFile(), mcfile, and msource.

Member Function Documentation

◆ assertain_character()

void ArtsParser::assertain_character ( char c )

private

Make sure that the current character is equal to c and go to the next character.

Parameters

[in] c Expected character.

Exceptions

UnexpectedChar The character is not right.

Definition at line 1842 of file parser.cc.

References SourceText::AdvanceChar(), c, SourceText::Column(), SourceText::Current(), SourceText::File(), SourceText::Line(), and msource.

Referenced by parse_generic_input(), parse_generic_output(), parse_intvector(), parse_matrix(), parse_method(), parse_method_args(), parse_numvector(), parse_specific_input(), parse_specific_output(), parse_String(), and parse_Stringvector().

◆ at_end_of_argument()

void ArtsParser::at_end_of_argument ( const String & argname )

private

Check if current position in controlfile is at the end of an argument.

Throws an UnexpectedChar exception if condition is not met.

Parameters

[in] argname Name of argument for error message

Exceptions

UnexpectedChar

Author: Oliver Lemke

Definition at line 141 of file parser.cc.

References SourceText::Column(), SourceText::Current(), eat_whitespace(), SourceText::File(), SourceText::Line(), and msource.

Referenced by parse_generic_input(), parse_generic_output(), parse_specific_input(), and parse_specific_output().

◆ eat_whitespace()

void ArtsParser::eat_whitespace ( )

private

Eats whitespace.

Comments are a special case of whitespace. Everything from the ‘#’ to the end of the line is eaten.

The whitespace cases implemented here must be consistent with is_whitespace!

See also: is_whitespace

Exceptions

UnexpectedChar Non-whitespace character encountered.

Definition at line 1661 of file parser.cc.

References SourceText::AdvanceChar(), SourceText::AdvanceLine(), SourceText::Column(), SourceText::Current(), SourceText::File(), is_whitespace(), SourceText::Line(), and msource.

Referenced by at_end_of_argument(), find_named_arguments(), parse_agenda(), parse_generic_input(), parse_generic_output(), parse_intvector(), parse_main(), parse_matrix(), parse_method(), parse_method_args(), parse_numvector(), parse_specific_input(), parse_specific_output(), parse_Stringvector(), and skip_to_next_argument().

◆ eat_whitespace_from_string()

void ArtsParser::eat_whitespace_from_string	(	String &	str,
		size_t &	pos
	)

private

Eats whitespace from a String.

Parameters

[in]	str	String.
[in,out]	pos	Current position in the String.

Definition at line 1690 of file parser.cc.

References is_whitespace().

Referenced by parse_intvector_from_string(), parse_numvector_from_string(), and parse_stringarray_from_string().

◆ find_named_arguments()

void ArtsParser::find_named_arguments ( vector< NamedArgument > & named_args )

private

Find named arguments.

This method is used to determine the position and the names of named arguments.

Parameters

[out] named_args List of named arguments.

Author: Oliver Lemke

Definition at line 47 of file parser.cc.

References SourceText::AdvanceChar(), SourceText::Column(), SourceText::ColumnRaw(), SourceText::Current(), eat_whitespace(), SourceText::File(), SourceText::Line(), SourceText::LineRaw(), msource, read_name(), and skip_to_next_argument().

Referenced by parse_method_args().

◆ get_argument_index_by_name()

void ArtsParser::get_argument_index_by_name	(	Index &	arg_index,
		NamedArguments &	named_args,
		const String &	name
	)

private

Return the index of the argument with the given name.

Author: Oliver Lemke

Definition at line 156 of file parser.cc.

Referenced by parse_generic_input(), parse_generic_output(), parse_specific_input(), and parse_specific_output().

◆ is_whitespace()

bool ArtsParser::is_whitespace ( const char c )

private

Returns true if this character is considered whitespace.

This includes the comment sign ‘#’. This function is used by other functions to test for delimiting whitespace.

The whitespace cases implemented here must be consistent with eat_whitespace!

Parameters

[in] c Character to test.

See also: eat_whitespace

Definition at line 1639 of file parser.cc.

References c.

Referenced by eat_whitespace(), and eat_whitespace_from_string().

◆ parse_agenda()

void ArtsParser::parse_agenda	(	Agenda &	tasklist,
		const String &	agenda_name
	)

private

Parse the Contents of text as ARTS control input.

This method is used to parse the list of methods given in the curly braces of an agenda method. So the end is marked by a closing curly brace ahead.

Parameters

[out] tasklist The method ids.

See also: eat_whitespace; parse_method

Author: Stefan Buehler

Definition at line 320 of file parser.cc.

References ARTS_ASSERT, SourceText::Column(), CREATE_OUT2, CREATE_OUT3, SourceText::Current(), Parameters::datapath, eat_whitespace(), SourceText::File(), find_file(), get_dirname(), get_wsv_group_id(), Parameters::includepath, SourceText::Line(), global_data::md_data, global_data::MdMap, msource, Array< base >::nelem(), parameters, parse_method(), parse_tasklist(), Agenda::push_back(), tasklist_insert_set_delete(), verbosity, ws, and global_data::wsv_groups.

Referenced by parse_method().

◆ parse_generic_input()

void ArtsParser::parse_generic_input	(	const MdRecord *&	mdd,
		Index &	id,
		String &	methodname,
		ArrayOfIndex &	input,
		ArrayOfIndex &	auto_vars,
		Array< TokVal > &	auto_vars_values,
		bool &	first,
		bool &	still_supergeneric,
		String &	supergeneric_args,
		Index &	supergeneric_index,
		NamedArguments &	named_args,
		bool	call_by_name
	)

private

Parse the generic input WSVs for current method from the controlfile.

Parameters

[in]	mdd	Pointer to the current WSM
[out]	id	Method index in md_data.
[out]	methodname	Name of the WSM
[out]	input	Input WSVs
[out]	auto_vars	Indexes of automatically created variables.
[out]	auto_vars_values	Values of automatically created variables.
[in,out]	first	If set to false, there must be a comma before the first WSV in the controlfile
[in,out]	still_supergeneric	True if the supergeneric method has not been expanded for the different types yet.

Author: Oliver Lemke

Date: 2008-03-05

Definition at line 968 of file parser.cc.

References assertain_character(), at_end_of_argument(), column, SourceText::Column(), SourceText::Current(), eat_whitespace(), SourceText::File(), get_argument_index_by_name(), get_wsv_group_id(), MdRecord::GIn(), MdRecord::GInSpecType(), MdRecord::GInType(), line, SourceText::Line(), global_data::md_data, global_data::MdMap, msource, MdRecord::Name(), Array< base >::nelem(), read_name_or_value(), set_gin_to_default(), MdRecord::SetMethod(), SourceText::SetPosition(), ws, and global_data::wsv_groups.

Referenced by parse_method_args().

◆ parse_generic_output()

void ArtsParser::parse_generic_output	(	const MdRecord *&	mdd,
		Index &	id,
		String &	methodname,
		ArrayOfIndex &	output,
		bool &	first,
		bool &	still_supergeneric,
		String &	supergeneric_args,
		Index &	supergeneric_index,
		NamedArguments &	named_args,
		bool	call_by_name
	)

private

Parse the generic output WSVs for current method from the controlfile.

Parameters

[in]	mdd	Pointer to the current WSM
[out]	id	Method index in md_data.
[out]	methodname	Name of the WSM
[out]	output	Output WSVs
[in,out]	first	If set to false, there must be a comma before the first WSV in the controlfile
[in,out]	still_supergeneric	True if the supergeneric method has not been expanded for the different types yet.

Author: Oliver Lemke

Date: 2008-03-05

Definition at line 1154 of file parser.cc.

References assertain_character(), at_end_of_argument(), column, SourceText::Column(), eat_whitespace(), SourceText::File(), get_argument_index_by_name(), get_wsv_group_id(), MdRecord::GOut(), MdRecord::GOutSpecType(), MdRecord::GOutType(), line, SourceText::Line(), global_data::md_data, global_data::MdMap, msource, MdRecord::Name(), Array< base >::nelem(), read_name(), SourceText::SetPosition(), var_string(), ws, and global_data::wsv_groups.

Referenced by parse_method_args().

◆ parse_integer()

void ArtsParser::parse_integer ( Index & n )

private

Use a String stream to parse an integer number.

Parameters

[out] n Parsed integer.

Definition at line 2055 of file parser.cc.

References read_integer().

Referenced by parse_intvector(), and read_name_or_value().

◆ parse_intvector()

void ArtsParser::parse_intvector ( ArrayOfIndex & res )

private

Read a vector of integers.

This looks as follows in the control file: [123,5,334] Whitespace has to have been eaten before, that is, the current character must be ‘[’.

The empty vector is allowed.

Line breaks are allowed before and after each number. Line breaks inside numbers are not allowed.

See also: parse_integer

Definition at line 2128 of file parser.cc.

References SourceText::AdvanceChar(), assertain_character(), SourceText::Current(), eat_whitespace(), msource, and parse_integer().

Referenced by read_name_or_value().

◆ parse_intvector_from_string()

bool ArtsParser::parse_intvector_from_string	(	ArrayOfIndex &	res,
		String &	str
	)

private

Read an array of integers from a String.

This looks as follows: [1, 5] Whitespace has to have been eaten before, that is, the current character must be ‘[’.

The empty vector is allowed.

See also: parse_intvector

Definition at line 2311 of file parser.cc.

References SourceText::Column(), eat_whitespace_from_string(), SourceText::File(), SourceText::Line(), msource, and Array< base >::nelem().

Referenced by set_gin_to_default().

◆ parse_main()

void ArtsParser::parse_main ( )

private

The main function of the parser.

This will parse the entire text.

Author: Stefan Buehler, Oliver Lemke

Definition at line 171 of file parser.cc.

References SourceText::Column(), ParseError::column(), CREATE_OUT0, CREATE_OUT3, eat_whitespace(), SourceText::File(), ParseError::file(), SourceText::Init(), SourceText::Line(), ParseError::line(), global_data::md_data, msource, mtasklist, parse_method(), and SourceText::reachedEot().

Referenced by parse_tasklist().

◆ parse_matrix()

void ArtsParser::parse_matrix ( Matrix & res )

private

Read a Matrix.

This looks as follows in the control file: [1, 2, 3; 4, 5, 6] Whitespace has to have been eaten before, that is, the current character must be ‘[’.

The empty matrix is allowed.

Line breaks are allowed before and after each number. Line breaks inside numbers are not allowed.

See also: parse_numeric

Definition at line 2220 of file parser.cc.

References SourceText::AdvanceChar(), assertain_character(), c, SourceText::Column(), SourceText::Current(), eat_whitespace(), SourceText::File(), SourceText::Line(), msource, and parse_numeric().

Referenced by read_name_or_value().

◆ parse_method()

void ArtsParser::parse_method	(	Index &	id,
		ArrayOfIndex &	output,
		ArrayOfIndex &	input,
		Agenda &	tasks,
		ArrayOfIndex &	auto_vars,
		Array< TokVal > &	auto_vars_values,
		String &	include_file,
		bool	no_eot = `false`
	)

private

Parse the Contents of text as ARTS control input.

Either values or tasks will be empty.

Parameters

[out]	id	Method id.
[out]	output	Output workspace variables (for generic methods).
[out]	input	Input workspace variables (for generic methods).
[out]	tasks	A list of other methods.
[out]	auto_vars	Indexes of automatically created variables.
[out]	auto_vars_values	Values of automatically created variables.
[out]	include_file	The input to parse.
[in]	no_eot	Suppress throwing an error on EOT after the closing curly brace.

See also: read_name; eat_whitespace; assertain_character; parse_String; parse_integer; parse_numeric; parse_Stringvector; parse_intvector; parse_numvector; parse_matrix

Exceptions

UnknownMethod
UnknownWsv
WrongWsvGroup

Author: Stefan Buehler

Definition at line 483 of file parser.cc.

References SourceText::AdvanceChar(), MdRecord::AgendaMethod(), assertain_character(), SourceText::Column(), CREATE_OUT3, SourceText::Current(), eat_whitespace(), SourceText::File(), SourceText::Line(), mcfile_version, msource, MdRecord::Name(), parse_agenda(), parse_method_args(), parse_String(), read_name(), Agenda::resize(), and SourceText::SetMark().

Referenced by parse_agenda(), and parse_main().

◆ parse_method_args()

void ArtsParser::parse_method_args	(	const MdRecord *&	mdd,
		Index &	id,
		String &	methodname,
		ArrayOfIndex &	output,
		ArrayOfIndex &	input,
		ArrayOfIndex &	auto_vars,
		Array< TokVal > &	auto_vars_values
	)

private

Parse method's argument list.

This function parses a method's argument list.

Parameters

[in]	mdd	Method
[out]	id	Method index in md_data.
[out]	methodname	Name of the WSM
[out]	output	Output WSVs
[out]	input	Input WSVs
[out]	auto_vars	Indexes of automatically created variables.
[out]	auto_vars_values	Values of automatically created variables.

Author: Oliver Lemke

Date: 2008-03-05

Definition at line 745 of file parser.cc.

References SourceText::AdvanceChar(), ARTS_ASSERT, assertain_character(), column, SourceText::Column(), SourceText::ColumnRaw(), SourceText::Current(), eat_whitespace(), SourceText::File(), find_named_arguments(), MdRecord::GIn(), MdRecord::GOut(), line, SourceText::Line(), SourceText::LineRaw(), SourceText::MarkedColumn(), SourceText::MarkedLine(), global_data::md_data, global_data::md_data_raw, global_data::MdMap, global_data::MdRawMap, msource, MdRecord::Name(), parse_generic_input(), parse_generic_output(), parse_specific_input(), parse_specific_output(), read_name(), SourceText::SetPosition(), MdRecord::Supergeneric(), and use_default_method_args().

Referenced by parse_method().

◆ parse_numeric()

void ArtsParser::parse_numeric ( Numeric & n )

private

Use a String stream to parse a floating point number.

Parameters

[out] n Parsed numeric.

Definition at line 2066 of file parser.cc.

References read_numeric().

Referenced by parse_matrix(), parse_numvector(), and read_name_or_value().

◆ parse_numvector()

void ArtsParser::parse_numvector ( Vector & res )

private

Read a vector of Numerics.

This looks as follows in the control file: [1.3, 5, 3.4] Whitespace has to have been eaten before, that is, the current character must be ‘[’.

The empty vector is allowed.

Line breaks are allowed before and after each number. Line breaks inside numbers are not allowed.

See also: parse_numeric

Definition at line 2169 of file parser.cc.

References SourceText::AdvanceChar(), assertain_character(), SourceText::Current(), eat_whitespace(), msource, Array< base >::nelem(), and parse_numeric().

Referenced by read_name_or_value().

◆ parse_numvector_from_string()

bool ArtsParser::parse_numvector_from_string	(	Vector &	res,
		String &	str
	)

private

Read a vector of Numerics from a String.

This looks as follows: [1.3, 5] Whitespace has to have been eaten before, that is, the current character must be ‘[’.

The empty vector is allowed.

See also: parse_numeric

Definition at line 2373 of file parser.cc.

References SourceText::Column(), eat_whitespace_from_string(), SourceText::File(), SourceText::Line(), msource, and Array< base >::nelem().

Referenced by set_gin_to_default().

◆ parse_specific_input()

void ArtsParser::parse_specific_input	(	const MdRecord *	mdd,
		ArrayOfIndex &	input,
		ArrayOfIndex &	auto_vars,
		Array< TokVal > &	auto_vars_values,
		bool &	first,
		NamedArguments &	named_args,
		bool	call_by_name
	)

private

Parse the specific input WSVs for current method from the controlfile.

Parameters

[in]	mdd	Pointer to the current WSM
[out]	input	Indexes of input variables for the WSM
[out]	auto_vars	Indexes of automatically created variables.
[out]	auto_vars_values	Values of automatically created variables.
[in]	first	If set to false, there must be a comma before the first WSV in the controlfile

Author: Oliver Lemke

Date: 2008-03-05

Definition at line 1355 of file parser.cc.

References assertain_character(), at_end_of_argument(), column, SourceText::Column(), eat_whitespace(), SourceText::File(), get_argument_index_by_name(), MdRecord::InOnly(), line, SourceText::Line(), msource, MdRecord::Out(), read_name_or_value(), SourceText::SetPosition(), ws, and global_data::wsv_groups.

Referenced by parse_method_args().

◆ parse_specific_output()

void ArtsParser::parse_specific_output	(	const MdRecord *	mdd,
		ArrayOfIndex &	output,
		bool &	first,
		NamedArguments &	named_args,
		bool	call_by_name
	)

private

Parse the output WSVs for current method from the controlfile.

Parameters

[in]	mdd	Pointer to the current WSM
[out]	output	Indexes of output variables for the WSM
[in]	first	If set to false, there must be a comma before the first WSV in the controlfile

Author: Oliver Lemke

Date: 2008-03-05

Definition at line 1455 of file parser.cc.

References assertain_character(), at_end_of_argument(), column, SourceText::Column(), eat_whitespace(), SourceText::File(), get_argument_index_by_name(), line, SourceText::Line(), msource, MdRecord::Name(), MdRecord::Out(), read_name(), SourceText::SetPosition(), ws, and global_data::wsv_groups.

Referenced by parse_method_args().

◆ parse_String()

void ArtsParser::parse_String ( String & res )

private

Reads a String, complete with quotation marks.

Whitespace has to have been eaten before, that is, the current character must be the quotation mark ("). Quotation marks inside Strings are currently not possible.

Line breaks inside Strings are not allowed.

Parameters

[out] res Output string.

Exceptions

IllegalLinebreak An illegal linebreak has occured.

Definition at line 1863 of file parser.cc.

References SourceText::AdvanceChar(), assertain_character(), SourceText::Column(), SourceText::Current(), SourceText::File(), SourceText::Line(), SourceText::LineBreak(), and msource.

Referenced by parse_method(), parse_Stringvector(), and read_name_or_value().

◆ parse_stringarray_from_string()

bool ArtsParser::parse_stringarray_from_string	(	ArrayOfString &	res,
		String &	str
	)

private

Read an Array of Strings from a String.

This looks as follows: [ "String1", "String2"] Whitespace has to have been eaten before, that is, the current character must be ‘[’.

The empty vector is allowed.

See also: parse_numeric

Definition at line 2440 of file parser.cc.

References SourceText::Column(), eat_whitespace_from_string(), SourceText::File(), SourceText::Line(), msource, and Array< base >::nelem().

Referenced by set_gin_to_default().

◆ parse_Stringvector()

void ArtsParser::parse_Stringvector ( ArrayOfString & res )

private

Read a vector of Strings.

This looks as follows in the control file: ["String1","String2"]

Whitespace has to have been eaten before, that is, the current character must be ‘[’.

The empty vector is allowed.

Quotation marks inside Strings are currently not possible.

Line breaks are allowed before and after each String. Line breaks inside Strings are not allowed.

See also: parse_String

Definition at line 2087 of file parser.cc.

References SourceText::AdvanceChar(), assertain_character(), SourceText::Current(), eat_whitespace(), msource, and parse_String().

Referenced by read_name_or_value().

◆ parse_tasklist()

void ArtsParser::parse_tasklist ( )

Public interface to the main function of the parser.

Author: Oliver Lemke

Definition at line 37 of file parser.cc.

References parse_main().

Referenced by main(), and parse_agenda().

◆ read_integer()

void ArtsParser::read_integer ( String & res )

private

Reads an integer.

Whitespace has to have been eaten before, that is, the current character must be a number or ‘+’ or ‘-’.

Whitespace or line breaks terminate the scanning! There are no whitespaces allowed anywhere, consisten with ANSI C scanf.

Parameters

[out] res Output string containing the integer.

Exceptions

IllegalLinebreak	An illegal linebreak has occured.
UnexpectedChar	Unexpected character encountered.

Definition at line 1905 of file parser.cc.

References SourceText::AdvanceChar(), SourceText::Column(), SourceText::Current(), SourceText::File(), SourceText::Line(), SourceText::LineBreak(), and msource.

Referenced by parse_integer(), and read_numeric().

◆ read_name()

void ArtsParser::read_name ( String & name )

private

Reads name of method, keyword, or workspace variable.

These names may consist only of letters (case matters!), numbers, and underscores. Line break or any other character ends the name.

Whitespace has to have been eaten before. Scanns source for the name, starting at position specified by line and column.

Parameters

[out] name Method, keyword or WSV name

Definition at line 1705 of file parser.cc.

References SourceText::AdvanceChar(), SourceText::Column(), SourceText::Current(), SourceText::File(), SourceText::Line(), SourceText::LineBreak(), and msource.

Referenced by find_named_arguments(), parse_generic_output(), parse_method(), parse_method_args(), parse_specific_output(), and read_name_or_value().

◆ read_name_or_value()

Index ArtsParser::read_name_or_value	(	String &	name,
		ArrayOfIndex &	auto_vars,
		Array< TokVal > &	auto_vars_values,
		const String &	default_name,
		const MdRecord *	mdd,
		const Index	group
	)

private

Reads name of a workspace variable or a value.

These names may consist only of letters (case matters!), numbers, and underscores. Line break or any other character ends the name.

Whitespace has to have been eaten before. Scanns source for the name, starting at position specified by line and column.

Parameters

[out]	name	WSV name or value
[in,out]	auto_vars	Indexes of automatically created variables.
[in,out]	auto_vars_values	Values of automatically created variables.
[in]	default_name	Default WSV name.
[in]	mdd	Pointer to the current WSM
[in]	group	Expected WSV group index

Returns: -1 If a WSV name was found or the index of the newly created WSV

Definition at line 1750 of file parser.cc.

References SourceText::Column(), SourceText::Current(), SourceText::File(), get_wsv_group_id(), SourceText::Line(), msource, MdRecord::Name(), my_basic_string< charT >::nelem(), parse_integer(), parse_intvector(), parse_matrix(), parse_numeric(), parse_numvector(), parse_String(), parse_Stringvector(), read_name(), ws, and global_data::wsv_groups.

Referenced by parse_generic_input(), and parse_specific_input().

◆ read_numeric()

void ArtsParser::read_numeric ( String & res )

private

Reads a floating point number.

Whitespace has to have been eaten before, that is, the current character must be a number or ‘+’ or ‘-’.

Example numbers: 23., 1.0, -.3, -3.3e5, +3e8, 1.0E-9

Illegal numbers: ., 3e, e3, 2e-

Whitespace is not allowed inside the number. Line breaks or whitespace terminates the scanning.

Parameters

[out] res Output string containing the numeric.

Exceptions

IllegalLinebreak	Illegal line break.
ParseError	Cannot parse this as a number.

Definition at line 1957 of file parser.cc.

References SourceText::AdvanceChar(), SourceText::Column(), SourceText::Current(), SourceText::File(), SourceText::Line(), SourceText::LineBreak(), msource, and read_integer().

Referenced by parse_numeric().

◆ set_gin_to_default()

String ArtsParser::set_gin_to_default	(	const MdRecord *	mdd,
		ArrayOfIndex &	auto_vars,
		Array< TokVal > &	auto_vars_values,
		Index	gin_index
	)

private

Set generic input to default value.

Sets the value of the generic input with the given index to its default value.

Parameters

[in]	mdd	Method object.
[out]	auto_vars	Indexes of automatically created variables.
[out]	auto_vars_values	Values of automatically created variables.
[in]	gin_index	Index of the generic input which should be set to its default value.

Returns: Workspace variable name containing the default value

Author: Oliver Lemke

Date: 2008-07-16

Definition at line 590 of file parser.cc.

References SourceText::Column(), ParseError::column(), SourceText::File(), ParseError::file(), get_wsv_group_id(), MdRecord::GIn(), MdRecord::GInDefault(), MdRecord::GInType(), SourceText::Line(), ParseError::line(), msource, MdRecord::Name(), my_basic_string< charT >::nelem(), NODEF, parse_intvector_from_string(), parse_numvector_from_string(), parse_stringarray_from_string(), v, ws, and global_data::wsv_groups.

Referenced by parse_generic_input(), and use_default_method_args().

◆ skip_to_next_argument()

void ArtsParser::skip_to_next_argument ( )

private

Skips forward to the next argument.

Author: Oliver Lemke

Definition at line 78 of file parser.cc.

References SourceText::AdvanceChar(), SourceText::AdvanceLine(), SourceText::Column(), SourceText::ColumnRaw(), SourceText::Current(), eat_whitespace(), SourceText::File(), SourceText::Line(), SourceText::LineRaw(), msource, and SourceText::SetPosition().

Referenced by find_named_arguments().

◆ tasklist_insert_set_delete()

void ArtsParser::tasklist_insert_set_delete	(	const ArrayOfIndex &	auto_vars,
		const Array< TokVal > &	auto_vars_values,
		const Index	method_type,
		Agenda &	tasklist
	)

private

Insert Set and Delete methods for automatically allocated output WSVs.

This function inserts either a bunch of Set or Delete methods for implicitly allocated output WSVs. This needs to be done if the controlfile contains a value instead of an output variable name.

See also: ArtsParser::parse_agenda

Parameters

[in]	auto_vars	Indexes of automatically created variables.
[in]	auto_vars_values	Values of automatically created variables.
[in]	method_type	0 = insert Set method, 1 = insert Delete method.
[out]	tasklist	Agenda to which the methods should be appended.

Definition at line 1562 of file parser.cc.

References ARTS_ASSERT, SourceText::Column(), SourceText::File(), get_wsv_group_id(), SourceText::Line(), global_data::MdMap, msource, Array< base >::nelem(), Agenda::push_back(), ws, and global_data::wsv_groups.

Referenced by parse_agenda().

◆ use_default_method_args()

void ArtsParser::use_default_method_args	(	const MdRecord *	mdd,
		String &	methodname,
		ArrayOfIndex &	output,
		ArrayOfIndex &	input,
		ArrayOfIndex &	auto_vars,
		Array< TokVal > &	auto_vars_values
	)

private

Set defaults if method is called without any arguments.

Parameters

[in]	mdd	Method
[out]	methodname	Name of the WSM
[out]	output	Output WSVs
[out]	input	Input WSVs
[out]	auto_vars	Indexes of automatically created variables.
[out]	auto_vars_values	Values of automatically created variables.

Author: Oliver Lemke

Date: 2023-01-11

Definition at line 888 of file parser.cc.

References SourceText::File(), MdRecord::GIn(), MdRecord::GInDefault(), MdRecord::GOut(), MdRecord::InOnly(), SourceText::MarkedColumn(), SourceText::MarkedLine(), msource, Array< base >::nelem(), NODEF, MdRecord::Out(), set_gin_to_default(), and ws.

Referenced by parse_method_args().

Member Data Documentation

◆ column

Index ArtsParser::column

private

Definition at line 19 of file parser.h.

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

◆ line

Index ArtsParser::line

private

Definition at line 18 of file parser.h.

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

◆ mcfile

String ArtsParser::mcfile

private

Definition at line 153 of file parser.h.

Referenced by ArtsParser().

◆ mcfile_version

Index ArtsParser::mcfile_version

private

Definition at line 157 of file parser.h.

Referenced by parse_method().

◆ msource

◆ mtasklist

Agenda& ArtsParser::mtasklist

private

Definition at line 149 of file parser.h.

Referenced by parse_main().

◆ verbosity

const Verbosity& ArtsParser::verbosity

private

Definition at line 159 of file parser.h.

Referenced by parse_agenda().

◆ ws

std::shared_ptr<Workspace> ArtsParser::ws

private

Definition at line 151 of file parser.h.

Referenced by parse_agenda(), parse_generic_input(), parse_generic_output(), parse_specific_input(), parse_specific_output(), read_name_or_value(), set_gin_to_default(), tasklist_insert_set_delete(), and use_default_method_args().

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ NamedArgument

◆ NamedArguments

Constructor & Destructor Documentation

◆ ArtsParser()

Member Function Documentation

◆ assertain_character()

◆ at_end_of_argument()

◆ eat_whitespace()

◆ eat_whitespace_from_string()

◆ find_named_arguments()

◆ get_argument_index_by_name()

◆ is_whitespace()

◆ parse_agenda()

◆ parse_generic_input()

◆ parse_generic_output()

◆ parse_integer()

◆ parse_intvector()

◆ parse_intvector_from_string()

◆ parse_main()

◆ parse_matrix()

◆ parse_method()

◆ parse_method_args()

◆ parse_numeric()

◆ parse_numvector()

◆ parse_numvector_from_string()

◆ parse_specific_input()

◆ parse_specific_output()

◆ parse_String()

◆ parse_stringarray_from_string()

◆ parse_Stringvector()

◆ parse_tasklist()

◆ read_integer()

◆ read_name()

◆ read_name_or_value()

◆ read_numeric()

◆ set_gin_to_default()

◆ skip_to_next_argument()

◆ tasklist_insert_set_delete()

◆ use_default_method_args()

Member Data Documentation

◆ column

◆ line

◆ mcfile

◆ mcfile_version

◆ msource

◆ mtasklist

◆ verbosity

◆ ws