Moved CCL Map, record syntax, charset normalization, record syntax normalization...
[pazpar2-moved-to-github.git] / src / config.h
1 #ifndef CONFIG_H
2 #define CONFIG_H
3
4 #include <libxslt/xslt.h>
5 #include <libxslt/transform.h>
6 #include <libxslt/xsltutils.h>
7
8 enum conf_sortkey_type
9 {
10     Metadata_sortkey_relevance,
11     Metadata_sortkey_numeric,       // Standard numerical sorting
12     Metadata_sortkey_skiparticle,   // Skip leading article when sorting
13     Metadata_sortkey_string         // Flat string
14 };
15
16 // Describes known metadata elements and how they are to be manipulated
17 // An array of these structure provides a 'map' against which discovered metadata
18 // elements are matched. It also governs storage, to minimize number of cycles needed
19 // at various tages of processing
20 struct conf_metadata 
21 {
22     char *name;  // The name of this element. Output by normalization stylesheet
23     int brief;   // Is this element to be returned in the brief format?
24     int termlist;// Is this field to be treated as a termlist for browsing?
25     int rank;    // Rank factor. 0 means don't use this field for ranking, 1 is default
26                  // values >1  give additional significance to a field
27     int sortkey_offset; // -1 if it's not a sortkey, otherwise index
28                         // into service/record_cluster->sortkey array
29     enum
30     {
31         Metadata_type_generic,          // Generic text field
32         Metadata_type_number,           // A number
33         Metadata_type_year              // A number
34     } type;
35     enum
36     {
37         Metadata_merge_no,              // Don't merge
38         Metadata_merge_unique,          // Include unique elements in merged block
39         Metadata_merge_longest,         // Include the longest (strlen) value
40         Metadata_merge_range,           // Store value as a range of lowest-highest
41         Metadata_merge_all              // Just include all elements found
42     } merge;
43 };
44
45 // Controls sorting
46 struct conf_sortkey
47 {
48     char *name;
49     enum conf_sortkey_type type;
50 };
51
52 // It is conceivable that there will eventually be several 'services' offered
53 // from one server, with separate configuration -- possibly more than one services
54 // associated with the same port. For now, however, only a single service is possible.
55 struct conf_service
56 {
57     int num_metadata;
58     struct conf_metadata *metadata;
59     int num_sortkeys;
60     struct conf_sortkey *sortkeys;
61 };
62
63 struct conf_server
64 {
65     char *host;
66     int port;
67     char *proxy_host;
68     int proxy_port;
69     char *myurl;
70     char *zproxy_host;
71     int zproxy_port;
72     char *settings;
73     struct conf_service *service;
74     struct conf_server *next;
75 };
76
77 struct conf_targetprofiles
78 {
79     enum {
80         Targetprofiles_local
81     } type;
82     char *src;
83 };
84
85 struct conf_config
86 {
87     struct conf_server *servers;
88     struct conf_targetprofiles *targetprofiles;
89 };
90
91 #ifndef CONFIG_NOEXTERNS
92
93 extern struct conf_config *config;
94
95 #endif
96
97 int read_config(const char *fname);
98 xsltStylesheet *conf_load_stylesheet(const char *fname);
99
100 #endif
101
102 /*
103  * Local variables:
104  * c-basic-offset: 4
105  * indent-tabs-mode: nil
106  * End:
107  * vim: shiftwidth=4 tabstop=8 expandtab
108  */