Function Table Resolver API

Collaboration diagram for Function Table Resolver API:

Functions
int	amxo_resolver_ftab_add (amxo_parser_t *parser, const char *fn_name, amxo_fn_ptr_t fn)
	Adds a C function to the function table. More...
int	amxo_resolver_ftab_remove (amxo_parser_t *parser, const char *fn_name)
	Removes a function from the function table. More...
void	amxo_resolver_ftab_clear (amxo_parser_t *parser)
	Removes all functions from the function table. More...

Detailed Description

Function Documentation

amxo_resolver_ftab_add()

int amxo_resolver_ftab_add	(	amxo_parser_t *	parser,
		const char *	fn_name,
		amxo_fn_ptr_t	fn
	)

Adds a C function to the function table.

Adds a C function to the function table resolver. The same function can be added multiple times using a different name. This makes it possible to use the same implementation for different data model methods.

Function names can be prepended with the full object path.

For an example see Function Table Resolver

Note

Supply function pointers to the function table resolver prior to parsing an odl file. By default the function table contains some parameter validation functions:

• check_minimum
• check_minimum_length
• check_maximum
• check_maximum_length
• check_range
• check_enum When using the same parser instance for parsing multiple odl files, there is no need to add the functions again, the function table is not cleared after parsing. The function amxo_parser_clean will remove all functions from the table, including the default parameter validation functions.

Parameters

parser	the odl parser instance
fn_name	the data model method name
fn	the function pointer (C implementation), use macro AMXO_FUNC

Returns

Retruns 0 when the function is added to the function table.

Definition at line 169 of file amxo_ftab_resolver.c.

                                             {
    int retval = -1;
    amxo_ftab_fn_t* ftab_fn = NULL;
    amxc_htable_t* ftab_data = NULL;
    when_null(parser, exit);
    when_null(fn, exit);
    when_true(!amxo_ftab_func_name_is_valid(fn_name), exit);
 
    ftab_data = amxo_parser_claim_resolver_data(parser, "ftab");
    when_null(ftab_data, exit);
    when_true(amxc_htable_contains(ftab_data, fn_name), exit);
 
    ftab_fn = (amxo_ftab_fn_t*) calloc(1, sizeof(amxo_ftab_fn_t));
    when_null(ftab_fn, exit);
 
    ftab_fn->fn = fn;
    amxc_htable_insert(ftab_data, fn_name, &ftab_fn->hit);
 
    retval = 0;
 
exit:
    return retval;
}

amxo_resolver_ftab_clear()

void amxo_resolver_ftab_clear

(

amxo_parser_t *

parser

)

Removes all functions from the function table.

Removes all entries from the function table.

Parameters

parser

the odl parser instance

Definition at line 215 of file amxo_ftab_resolver.c.

                                                     {
    when_null(parser, exit);
    amxo_resolver_ftab_clean(parser, NULL);
 
exit:
    return;
}

amxo_resolver_ftab_remove()

int amxo_resolver_ftab_remove	(	amxo_parser_t *	parser,
		const char *	fn_name
	)

Removes a function from the function table.

Removes a single entry from the function table.

Parameters

parser	the odl parser instance
fn_name	the data model method name

Returns

Retruns 0 when the function is removed from the function table.

Definition at line 195 of file amxo_ftab_resolver.c.

                                                   {
    int retval = -1;
    amxc_htable_t* ftab_data = NULL;
    amxc_htable_it_t* it = NULL;
    when_null(parser, exit);
    when_str_empty(fn_name, exit);
    ftab_data = amxo_parser_claim_resolver_data(parser, "ftab");
    when_null(ftab_data, exit);
 
    it = amxc_htable_get(ftab_data, fn_name);
    if(it != NULL) {
        amxc_htable_it_clean(it, amxo_ftab_fn_free);
    }
    retval = 0;
 
exit:
    return retval;
}