native_json_config.h

Go to the documentation of this file.

/**
 * @file
 * @brief Declares lightweight JSON and conf value lookup helpers.
 */
 
#ifndef PHAROS_NATIVE_JSON_CONFIG_H
#define PHAROS_NATIVE_JSON_CONFIG_H
 
/** @name JSON and conf lookup helpers
 * @{
 */
/**
 * @brief Finds a JSON string value for a key after a given scan position.
 * @param text JSON text to search.
 * @param key Key name to locate.
 * @param start_at Pointer within text where scanning should begin.
 * @return Newly allocated string value, or NULL when the key is not found.
 */
char *json_find_string_after(const char *text, const char *key, const char *start_at);
/**
 * @brief Finds the first JSON string value associated with a key.
 * @param text JSON text to search.
 * @param key Key name to locate.
 * @return Newly allocated string value, or NULL when the key is not found.
 */
char *json_find_string(const char *text, const char *key);
/**
 * @brief Finds a JSON string value for a key inside a named section object.
 * @param text JSON text to search.
 * @param section Section name that should contain the key.
 * @param key Key name to locate inside the section.
 * @return Newly allocated string value, or NULL when the key is not found.
 */
char *json_find_string_in_section(const char *text, const char *section, const char *key);
/**
 * @brief Extracts the raw JSON array text for a key inside a named section.
 * @param text JSON text to search.
 * @param section Section name that should contain the array.
 * @param key Array-valued key to locate.
 * @return Newly allocated raw array text, or NULL when the array is not found.
 */
char *json_extract_array_in_section(const char *text, const char *section, const char *key);
/**
 * @brief Looks up one key from Pharos conf-format text.
 * @param text Config text to search.
 * @param key Config key to locate.
 * @return Newly allocated config value, or NULL when the key is not found.
 */
char *conf_lookup_value_in_text(const char *text, const char *key);
/**
 * @brief Reads a Pharos conf file and looks up one key.
 * @param path Path to the config file.
 * @param key Config key to locate.
 * @return Newly allocated config value, or NULL when the key is not found or the file cannot be read.
 */
char *conf_lookup_value(const char *path, const char *key);
 
 
/** @} */
#endif