represents keywords in an input More...

Data Types
type	keyword_p_type
	represent a pointer to a keyword (to make arrays of pointers) More...

type	keyword_type
	represent a keyword in the input More...

Functions/Subroutines
subroutine, public	keyword_create (keyword, location, name, description, usage, type_of_var, n_var, repeats, variants, default_val, default_l_val, default_r_val, default_lc_val, default_c_val, default_i_val, default_l_vals, default_r_vals, default_c_vals, default_i_vals, lone_keyword_val, lone_keyword_l_val, lone_keyword_r_val, lone_keyword_c_val, lone_keyword_i_val, lone_keyword_l_vals, lone_keyword_r_vals, lone_keyword_c_vals, lone_keyword_i_vals, enum_c_vals, enum_i_vals, enum, enum_strict, enum_desc, unit_str, citations, deprecation_notice, removed)
	creates a keyword object

subroutine, public	keyword_retain (keyword)
	retains the given keyword (see doc/ReferenceCounting.html)

subroutine, public	keyword_release (keyword)
	releases the given keyword (see doc/ReferenceCounting.html)

subroutine, public	keyword_get (keyword, names, usage, description, type_of_var, n_var, default_value, lone_keyword_value, repeats, enum, citations)
	...

subroutine, public	keyword_describe (keyword, unit_nr, level)
	writes out a description of the keyword

subroutine, public	write_keyword_xml (keyword, level, unit_number)
	Prints a description of a keyword in XML format.

subroutine, public	keyword_typo_match (keyword, unknown_string, location_string, matching_rank, matching_string, bonus)
	...

Variables
integer, parameter, public	usage_string_length = default_string_length*2

Detailed Description

represents keywords in an input

History: 06.2004 created, based on Joost cp_keywords proposal [fawzi]

Author: fawzi

Function/Subroutine Documentation

◆ keyword_create()

subroutine, public input_keyword_types::keyword_create	(	type(keyword_type), pointer	keyword,
		character(len=*), intent(in)	location,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	description,
		character(len=*), intent(in), optional	usage,
		integer, intent(in), optional	type_of_var,
		integer, intent(in), optional	n_var,
		logical, intent(in), optional	repeats,
		character(len=*), dimension(:), intent(in), optional	variants,
		type(val_type), optional, pointer	default_val,
		logical, intent(in), optional	default_l_val,
		real(kind=dp), intent(in), optional	default_r_val,
		character(len=*), intent(in), optional	default_lc_val,
		character(len=*), intent(in), optional	default_c_val,
		integer, intent(in), optional	default_i_val,
		logical, dimension(:), intent(in), optional	default_l_vals,
		real(kind=dp), dimension(:), intent(in), optional	default_r_vals,
		character(len=*), dimension(:), intent(in), optional	default_c_vals,
		integer, dimension(:), intent(in), optional	default_i_vals,
		type(val_type), optional, pointer	lone_keyword_val,
		logical, intent(in), optional	lone_keyword_l_val,
		real(kind=dp), intent(in), optional	lone_keyword_r_val,
		character(len=*), intent(in), optional	lone_keyword_c_val,
		integer, intent(in), optional	lone_keyword_i_val,
		logical, dimension(:), intent(in), optional	lone_keyword_l_vals,
		real(kind=dp), dimension(:), intent(in), optional	lone_keyword_r_vals,
		character(len=*), dimension(:), intent(in), optional	lone_keyword_c_vals,
		integer, dimension(:), intent(in), optional	lone_keyword_i_vals,
		character(len=*), dimension(:), intent(in), optional	enum_c_vals,
		integer, dimension(:), intent(in), optional	enum_i_vals,
		type(enumeration_type), optional, pointer	enum,
		logical, intent(in), optional	enum_strict,
		character(len=*), dimension(:), intent(in), optional	enum_desc,
		character(len=*), intent(in), optional	unit_str,
		integer, dimension(:), intent(in), optional	citations,
		character(len=*), intent(in), optional	deprecation_notice,
		logical, intent(in), optional	removed
	)

creates a keyword object

Parameters

keyword	the keyword object to be created
location	from where in the source code keyword_create() is called
name	the name of the keyword
description	...
usage	...
type_of_var	...
n_var	...
repeats	...
variants	...
default_val	...
default_l_val	...
default_r_val	...
default_lc_val	...
default_c_val	...
default_i_val	...
default_l_vals	...
default_r_vals	...
default_c_vals	...
default_i_vals	...
lone_keyword_val	...
lone_keyword_l_val	...
lone_keyword_r_val	...
lone_keyword_c_val	...
lone_keyword_i_val	...
lone_keyword_l_vals	...
lone_keyword_r_vals	...
lone_keyword_c_vals	...
lone_keyword_i_vals	...
enum_c_vals	...
enum_i_vals	...
enum	...
enum_strict	...
enum_desc	...
unit_str	...
citations	...
deprecation_notice	...
removed	...

Author: fawzi

Definition at line 147 of file input_keyword_types.F.

Here is the call graph for this function:

◆ keyword_retain()

subroutine, public input_keyword_types::keyword_retain ( type(keyword_type), pointer keyword )

retains the given keyword (see doc/ReferenceCounting.html)

Parameters

keyword the keyword to retain

Author: fawzi

Definition at line 425 of file input_keyword_types.F.

Here is the caller graph for this function:

◆ keyword_release()

subroutine, public input_keyword_types::keyword_release ( type(keyword_type), pointer keyword )

releases the given keyword (see doc/ReferenceCounting.html)

Parameters

keyword the keyword to release

Author: fawzi

Definition at line 438 of file input_keyword_types.F.

Here is the call graph for this function:

◆ keyword_get()

subroutine, public input_keyword_types::keyword_get	(	type(keyword_type), pointer	keyword,
		character(len=default_string_length), dimension(:), optional, pointer	names,
		character(len=*), intent(out), optional	usage,
		character(len=*), intent(out), optional	description,
		integer, intent(out), optional	type_of_var,
		integer, intent(out), optional	n_var,
		type(val_type), optional, pointer	default_value,
		type(val_type), optional, pointer	lone_keyword_value,
		logical, intent(out), optional	repeats,
		type(enumeration_type), optional, pointer	enum,
		integer, dimension(:), optional, pointer	citations
	)

...

Parameters

keyword	...
names	...
usage	...
description	...
type_of_var	...
n_var	...
default_value	...
lone_keyword_value	...
repeats	...
enum	...
citations	...

Author: fawzi

Definition at line 478 of file input_keyword_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ keyword_describe()

subroutine, public input_keyword_types::keyword_describe	(	type(keyword_type), pointer	keyword,
		integer, intent(in)	unit_nr,
		integer, intent(in)	level
	)

writes out a description of the keyword

Parameters

keyword	the keyword to describe
unit_nr	the unit to write to
level	the description level (0 no description, 1 name 2: +usage, 3: +variants+description+default_value+repeats 4: +type_of_var)

Author: fawzi

Definition at line 513 of file input_keyword_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write_keyword_xml()

subroutine, public input_keyword_types::write_keyword_xml	(	type(keyword_type), pointer	keyword,
		integer, intent(in)	level,
		integer, intent(in)	unit_number
	)

Prints a description of a keyword in XML format.

Parameters

keyword	The keyword to describe
level	...
unit_number	Number of the output unit

Author: Matthias Krack

Definition at line 647 of file input_keyword_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ keyword_typo_match()

subroutine, public input_keyword_types::keyword_typo_match	(	type(keyword_type), pointer	keyword,
		character(len=*)	unknown_string,
		character(len=*)	location_string,
		integer, dimension(:), intent(inout)	matching_rank,
		character(len=*), dimension(:), intent(inout)	matching_string,
		integer, intent(in)	bonus
	)

...

Parameters

keyword	...
unknown_string	...
location_string	...
matching_rank	...
matching_string	...
bonus	...

Definition at line 838 of file input_keyword_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ usage_string_length

integer, parameter, public input_keyword_types::usage_string_length = default_string_length*2

Definition at line 43 of file input_keyword_types.F.

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ keyword_create()

◆ keyword_retain()

◆ keyword_release()

◆ keyword_get()

◆ keyword_describe()

◆ write_keyword_xml()

◆ keyword_typo_match()

Variable Documentation

◆ usage_string_length