ODL Parser Configuration Options

Collaboration diagram for ODL Parser Configuration Options:

Functions
amxc_var_t *	amxo_parser_get_config (amxo_parser_t *parser, const char *path)
	Gets a configuration option. More...
amxc_var_t *	amxo_parser_claim_config (amxo_parser_t *parser, const char *path)
	Gets or creates a configuration option. More...
int	amxo_parser_set_config (amxo_parser_t *parser, const char *path, amxc_var_t *value)
	Sets a configuration option. More...

Detailed Description

Ambiorix ODL parser configuration API

A parser can contain configuration options. Accessing these configuration options can be done using these functions.

Function Documentation

amxo_parser_claim_config()

amxc_var_t* amxo_parser_claim_config	(	amxo_parser_t *	parser,
		const char *	path
	)

Gets or creates a configuration option.

The configuration options can be used by the function resolvers, the parser or the application itself

Configuration options change the behaviour of the parser, resolvers or the application itself

If the configuration option does not exists, it is added and intialized to a "null" variant.

Parameters

parser	the odl parser instance
path	the path of the configuration option

Returns

Returns the config option as a variant.

Definition at line 410 of file amxo_parser_main.c.

                                                       {
    amxc_var_t* retval = NULL;
    when_null(parser, exit);
    when_str_empty(path, exit);
 
    retval = amxo_parser_get_config(parser, path);
    if(retval == NULL) {
        // add a NULL variant
        amxc_var_t dummy;
        amxc_var_init(&dummy);
        amxo_parser_set_config(parser, path, &dummy);
        retval = amxo_parser_get_config(parser, path);
        amxc_var_clean(&dummy);
    }
 
exit:
    return retval;
}

amxo_parser_get_config()

amxc_var_t* amxo_parser_get_config	(	amxo_parser_t *	parser,
		const char *	path
	)

Gets a configuration option.

The configuration options can be used by the function resolvers, the parser or the application itself

Configuration options change the behaviour of the parser, resolvers or the application itself

Note

Freeing the returned amxc_var_t* using amxc_var_delete will remove the configuration option.

Parameters

parser	the odl parser instance
path	the path of the configuration option

Returns

Returns the config option as a variant or NULL when no option found with the name given. Freeing the returned variant will remove the config.

Definition at line 430 of file amxo_parser_main.c.

                                                     {
    amxc_var_t* retval = NULL;
    when_null(parser, exit);
    when_str_empty(path, exit);
 
    retval = amxc_var_get_path(&parser->config, path, AMXC_VAR_FLAG_DEFAULT);
 
exit:
    return retval;
}

amxo_parser_set_config()

int amxo_parser_set_config	(	amxo_parser_t *	parser,
		const char *	path,
		amxc_var_t *	value
	)

Sets a configuration option.

The configuration options can be used by the function resolvers or by the parser itself.

Configuration options change the behaviour of the parser, resolvers or the application.

If the configuration option does not exists, it is added. If it exists it's value is changed.

Parameters

parser	the odl parser instance
path	the path of the configuration option
value	the value of the configuration option as a variant

Returns

Returns 0 when success, any other value indicates failure.

Definition at line 442 of file amxo_parser_main.c.

                                              {
    int retval = 0;
    when_null(parser, exit);
    when_null(value, exit);
    when_str_empty(path, exit);
 
    retval = amxc_var_set_path(&parser->config,
                               path,
                               value,
                               AMXC_VAR_FLAG_UPDATE | AMXC_VAR_FLAG_COPY | AMXC_VAR_FLAG_AUTO_ADD);
 
exit:
    return retval;
}