field_urls.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
 
#include "ws_symbol_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define FIELDURLS_FILE_NAME  "fieldurls"  
 
/*
 * The "fieldurls" file in the personal configuration directory (shared by
 * all profiles) has one line per field or protocol abbreviation:
 *
 *     <abbrev> <url>
 *     <abbrev> {<items>}[flags]=<url> ... [<default url>]
 *
 * Fields are separated by whitespace and lines starting with '#' are
 * comments. A rule's <items> are a comma separated list of values, each
 * either unquoted (a value, an inclusive range "a..b", an IPv4 or IPv6
 * address, address range or CIDR network, which are compared as addresses
 * to values that are addresses) or double quoted (always text, with \" and
 * \\ as escapes). The optional flags are 'i' (case-insensitive) and '*'
 * (the value contains an item, instead of being equal to it). Rules are
 * tried in order against the value of the selected field and the first
 * match gives the URL. The URL at the end of the line is used if no rule
 * matches. The file is read once, on first use.
 */

WS_DLL_PUBLIC char *field_url_expand(const char *url, const char *fieldname, const char *fieldvalue);

WS_DLL_PUBLIC bool field_url_needs_value(const char *fieldname, const char *protoname);

WS_DLL_PUBLIC char *field_url_for(const char *fieldname, const char *protoname, const char *fieldvalue);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */