1 | /**********************************************************************
|
---|
2 | *
|
---|
3 | * formattools.h --
|
---|
4 | * Copyright (C) 1999 The New Zealand Digital Library Project
|
---|
5 | *
|
---|
6 | * A component of the Greenstone digital library software
|
---|
7 | * from the New Zealand Digital Library Project at the
|
---|
8 | * University of Waikato, New Zealand.
|
---|
9 | *
|
---|
10 | * This program is free software; you can redistribute it and/or modify
|
---|
11 | * it under the terms of the GNU General Public License as published by
|
---|
12 | * the Free Software Foundation; either version 2 of the License, or
|
---|
13 | * (at your option) any later version.
|
---|
14 | *
|
---|
15 | * This program is distributed in the hope that it will be useful,
|
---|
16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
18 | * GNU General Public License for more details.
|
---|
19 | *
|
---|
20 | * You should have received a copy of the GNU General Public License
|
---|
21 | * along with this program; if not, write to the Free Software
|
---|
22 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
23 | *
|
---|
24 | *********************************************************************/
|
---|
25 |
|
---|
26 |
|
---|
27 | #ifndef FORMATTOOLS_H
|
---|
28 | #define FORMATTOOLS_H
|
---|
29 |
|
---|
30 | #include "text_t.h"
|
---|
31 | #include "recptproto.h"
|
---|
32 | #include "display.h"
|
---|
33 |
|
---|
34 | enum command_t {comIf, comOr, comMeta, comText, comLink, comEndLink, comNum, comIcon,
|
---|
35 | comDoc, comHighlight, comEndHighlight,
|
---|
36 | comMetadataSpanWrap, comEndMetadataSpanWrap,
|
---|
37 | comRel, comHref, comSummary,
|
---|
38 | comTOC, comImage, comDocumentButtonDetach, comDocumentButtonHighlight,
|
---|
39 | comDocumentButtonExpandContents, comDocumentButtonExpandText, comOID, comTopOID, comRank,
|
---|
40 | comCollection, comDocTermsFreqTotal,
|
---|
41 | comAssocLink, comEndAssocLink};
|
---|
42 |
|
---|
43 | enum mcommand_t {mNone=0, mCgiSafe=1, mParent=2, mSibling=4, mChild=8, mSpecial=16, mTruncate=32, mXMLSafe=64, mHTMLSafe=128};
|
---|
44 |
|
---|
45 | enum pcommand_t {pNone, pImmediate, pTop, pAll};
|
---|
46 | enum scommand_t {sNone, sAll, sNum};
|
---|
47 | enum ccommand_t {cNone, cAll, cNum};
|
---|
48 | enum dcommand_t {dMeta, dText};
|
---|
49 |
|
---|
50 | struct metadata_t {
|
---|
51 | void clear();
|
---|
52 | metadata_t () {clear();}
|
---|
53 |
|
---|
54 | text_t metaname;
|
---|
55 | int metacommand; // used to hold flags from mcommand_t
|
---|
56 | struct {
|
---|
57 | pcommand_t parent;
|
---|
58 | scommand_t sibling;
|
---|
59 | ccommand_t child;
|
---|
60 | } mqualifier;
|
---|
61 |
|
---|
62 | text_t pre_tree_traverse;
|
---|
63 | text_t parentoptions;
|
---|
64 | text_t siblingoptions;
|
---|
65 | text_t childoptions;
|
---|
66 | };
|
---|
67 |
|
---|
68 |
|
---|
69 | // The decision component of an {If}{decision,true-text,false-text}
|
---|
70 | // formatstring. The decision can be based on metadata or on text;
|
---|
71 | // normally that text would be a macro like _cgiargmode_. --gordon
|
---|
72 | struct decision_t {
|
---|
73 | void clear();
|
---|
74 | decision_t () {clear();}
|
---|
75 |
|
---|
76 | dcommand_t command;
|
---|
77 | metadata_t meta;
|
---|
78 | text_t text;
|
---|
79 | };
|
---|
80 |
|
---|
81 | struct format_t {
|
---|
82 | void clear();
|
---|
83 | format_t () {clear();}
|
---|
84 | ~format_t();
|
---|
85 |
|
---|
86 | command_t command;
|
---|
87 | decision_t decision;
|
---|
88 | text_t text;
|
---|
89 | metadata_t meta;
|
---|
90 | format_t *nextptr;
|
---|
91 | format_t *ifptr;
|
---|
92 | format_t *elseptr;
|
---|
93 | format_t *orptr;
|
---|
94 | };
|
---|
95 |
|
---|
96 | // the format structure used by this receptionist
|
---|
97 | struct formatinfo_t {
|
---|
98 | void clear();
|
---|
99 | formatinfo_t () {clear();}
|
---|
100 |
|
---|
101 | bool DocumentImages;
|
---|
102 | bool DocumentTitles;
|
---|
103 | text_t DocumentHeading;
|
---|
104 | bool DocumentContents;
|
---|
105 | bool DocumentArrowsBottom;
|
---|
106 | bool DocumentArrowsTop;
|
---|
107 | bool DocumentSearchResultLinks;
|
---|
108 | text_tarray DocumentButtons;
|
---|
109 | text_t DocumentText;
|
---|
110 | //-----------------
|
---|
111 | text_t RelatedDocuments;
|
---|
112 | //----------------
|
---|
113 | text_tmap formatstrings;
|
---|
114 | bool DocumentUseHTML;
|
---|
115 | bool AllowExtendedOptions;
|
---|
116 | };
|
---|
117 |
|
---|
118 | bool is_table_content (const text_t &formatstring);
|
---|
119 | bool is_table_content (const format_t *formatlistptr);
|
---|
120 |
|
---|
121 | bool get_formatstring (const text_t &key, const text_tmap &formatstringmap,
|
---|
122 | text_t &formatstring);
|
---|
123 | bool get_formatstring (const text_t &key1, const text_t &key2,
|
---|
124 | const text_tmap &formatstringmap,
|
---|
125 | text_t &formatstring);
|
---|
126 |
|
---|
127 | text_t format_date (const text_t &date);
|
---|
128 |
|
---|
129 | text_t remove_namespace(const text_t &meta_name);
|
---|
130 |
|
---|
131 | text_t iso639 (const text_t &langcode);
|
---|
132 |
|
---|
133 | text_t get_href (const text_t &link);
|
---|
134 |
|
---|
135 | text_t get_related_docs(const text_t& collection, recptproto* collectproto,
|
---|
136 | ResultDocInfo_t &docinfo, ostream& logout);
|
---|
137 |
|
---|
138 |
|
---|
139 | bool parse_formatstring (const text_t &formatstring, format_t *formatlistptr,
|
---|
140 | text_tset &metadata, bool &getParents);
|
---|
141 |
|
---|
142 |
|
---|
143 |
|
---|
144 | text_t get_formatted_string (const text_t& collection, recptproto* collectproto,
|
---|
145 | ResultDocInfo_t &docinfo, displayclass &disp,
|
---|
146 | format_t *formatlistptr, text_tmap &options,
|
---|
147 | ostream& logout);
|
---|
148 |
|
---|
149 | #endif
|
---|
150 |
|
---|
151 |
|
---|