subsurface/core/taxonomy.h
Berthold Stoeger f93acdace7 cleanup: make alloc_taxonomy local to taxonomy.c
The alloc_taxonomy()/free_taxonomy() interface was exceedingly strange.
The former gave a "struct taxonomy", the latter took a "struct taxonomy_data".
To make things worse, is appears as if the names "taxonomy" and "taxonoma_data"
are reversed: the latter contains the former.

In any case, the alloc_taxonomy() call is not needed anymore from outside
taxonomy.c, as these memory-management details are now hidden in accessor
functions. Therefore, make the function local to taxonomy.c. Moreover,
rename it to "alloc_taxonomy_table()" and let it take a "taxonomy_data"
structure for symmetry with "free_taxonomy()".

Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
2020-09-06 12:59:54 -07:00

52 lines
1.4 KiB
C

// SPDX-License-Identifier: GPL-2.0
#ifndef TAXONOMY_H
#define TAXONOMY_H
#ifdef __cplusplus
extern "C" {
#endif
enum taxonomy_category {
TC_NONE,
TC_OCEAN,
TC_COUNTRY,
TC_ADMIN_L1,
TC_ADMIN_L2,
TC_LOCALNAME,
TC_ADMIN_L3,
TC_NR_CATEGORIES
};
enum taxonomy_origin {
GEOCODED,
GEOPARSED,
GEOMANUAL,
GEOCOPIED
};
extern char *taxonomy_category_names[TC_NR_CATEGORIES];
extern char *taxonomy_api_names[TC_NR_CATEGORIES];
struct taxonomy {
int category; /* the category for this tag: ocean, country, admin_l1, admin_l2, localname, etc */
const char *value; /* the value returned, parsed, or manually entered for that category */
enum taxonomy_origin origin;
};
/* the data block contains 3 taxonomy structures - unused ones have a tag value of NONE */
struct taxonomy_data {
int nr;
struct taxonomy *category;
};
void free_taxonomy(struct taxonomy_data *t);
void copy_taxonomy(const struct taxonomy_data *orig, struct taxonomy_data *copy);
int taxonomy_index_for_category(const struct taxonomy_data *t, enum taxonomy_category cat);
const char *taxonomy_get_country(struct taxonomy_data *t);
void taxonomy_set_category(struct taxonomy_data *t, enum taxonomy_category category, const char *value, enum taxonomy_origin origin);
void taxonomy_set_country(struct taxonomy_data *t, const char *country, enum taxonomy_origin origin);
#ifdef __cplusplus
}
#endif
#endif // TAXONOMY_H