source: main/trunk/greenstone2/runtime-src/src/recpt/formattools.h@ 21758

Last change on this file since 21758 was 21758, checked in by kjdon, 12 years ago

now we dynamically generate srclink (and /srclink, and new srchref which is the link without the a tag), using srclink_file metadata. This is to get gs2 receptionist stuff out of metadata and into the source code where it belongs

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 4.2 KB
Line 
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
34enum 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
43enum mcommand_t {mNone=0, mCgiSafe=1, mParent=2, mSibling=4, mChild=8, mSpecial=16, mTruncate=32, mXMLSafe=64, mHTMLSafe=128};
44
45enum pcommand_t {pNone, pImmediate, pTop, pAll};
46enum scommand_t {sNone, sAll, sNum};
47enum ccommand_t {cNone, cAll, cNum};
48enum dcommand_t {dMeta, dText};
49
50struct 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
72struct decision_t {
73 void clear();
74 decision_t () {clear();}
75
76 dcommand_t command;
77 metadata_t meta;
78 text_t text;
79};
80
81struct format_t {
82 void clear();
83 format_t () {clear();}
84
85 command_t command;
86 decision_t decision;
87 text_t text;
88 metadata_t meta;
89 format_t *nextptr;
90 format_t *ifptr;
91 format_t *elseptr;
92 format_t *orptr;
93};
94
95// the format structure used by this receptionist
96struct formatinfo_t {
97 void clear();
98 formatinfo_t () {clear();}
99
100 bool DocumentImages;
101 bool DocumentTitles;
102 text_t DocumentHeading;
103 bool DocumentContents;
104 bool DocumentArrowsBottom;
105 bool DocumentArrowsTop;
106 bool DocumentSearchResultLinks;
107 text_tarray DocumentButtons;
108 text_t DocumentText;
109 //-----------------
110 text_t RelatedDocuments;
111 //----------------
112 text_tmap formatstrings;
113 bool DocumentUseHTML;
114 bool AllowExtendedOptions;
115};
116
117bool is_table_content (const text_t &formatstring);
118bool is_table_content (const format_t *formatlistptr);
119
120bool get_formatstring (const text_t &key, const text_tmap &formatstringmap,
121 text_t &formatstring);
122bool get_formatstring (const text_t &key1, const text_t &key2,
123 const text_tmap &formatstringmap,
124 text_t &formatstring);
125
126text_t format_date (const text_t &date);
127
128text_t remove_namespace(const text_t &meta_name);
129
130text_t iso639 (const text_t &langcode);
131
132text_t get_href (const text_t &link);
133
134text_t get_related_docs(const text_t& collection, recptproto* collectproto,
135 ResultDocInfo_t &docinfo, ostream& logout);
136
137
138bool parse_formatstring (const text_t &formatstring, format_t *formatlistptr,
139 text_tset &metadata, bool &getParents);
140
141
142
143text_t get_formatted_string (const text_t& collection, recptproto* collectproto,
144 ResultDocInfo_t &docinfo, displayclass &disp,
145 format_t *formatlistptr, text_tmap &options,
146 ostream& logout);
147
148#endif
149
150
Note: See TracBrowser for help on using the repository browser.