root/gsdl/trunk/runtime-src/src/recpt/formattools.h @ 19046

Revision 19046, 4.1 KB (checked in by davidb, 11 years ago)

Qualifiers within metadata can now support a chain of parent: and child: terms, e.g. parent:child(All)

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
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, comRel, comHref, comSummary,
36        comTOC, comImage, comDocumentButtonDetach, comDocumentButtonHighlight,
37        comDocumentButtonExpandContents, comDocumentButtonExpandText, comOID, comTopOID, comRank,
38        comCollection, comDocTermsFreqTotal};
39
40enum mcommand_t {mNone=0, mCgiSafe=1, mParent=2, mSibling=4, mChild=8, mSpecial=16};
41
42enum pcommand_t {pNone, pImmediate, pTop, pAll};
43enum scommand_t {sNone, sAll, sNum};
44enum ccommand_t {cNone, cAll, cNum};
45enum dcommand_t {dMeta, dText};
46
47struct metadata_t {
48  void clear();
49  metadata_t () {clear();}
50
51  text_t metaname;
52  int metacommand; // used to hold flags from mcommand_t
53  struct {
54    pcommand_t parent;
55    scommand_t sibling;
56    ccommand_t child;
57  } mqualifier;
58
59  text_t pre_tree_traverse;
60  text_t parentoptions;
61  text_t siblingoptions;
62  text_t childoptions;
63};
64
65
66// The decision component of an {If}{decision,true-text,false-text}
67// formatstring.  The decision can be based on metadata or on text;
68// normally that text would be a macro like _cgiargmode_.  --gordon
69struct decision_t {
70  void clear();
71  decision_t () {clear();}
72
73  dcommand_t command;
74  metadata_t meta;
75  text_t text;
76};
77
78struct format_t {
79  void clear();
80  format_t () {clear();}
81
82  command_t command;
83  decision_t decision;
84  text_t text;
85  metadata_t meta;
86  format_t *nextptr;
87  format_t *ifptr;
88  format_t *elseptr;
89  format_t *orptr;
90};
91
92// the format structure used by this receptionist
93struct formatinfo_t {
94  void clear();
95  formatinfo_t () {clear();}
96
97  bool DocumentImages;
98  bool DocumentTitles;
99  text_t DocumentHeading;
100  bool DocumentContents;
101  bool DocumentArrowsBottom;
102  bool DocumentArrowsTop;
103  bool DocumentSearchResultLinks;
104  text_tarray DocumentButtons;
105  text_t DocumentText;
106  //-----------------
107  text_t RelatedDocuments;
108  //----------------
109  text_tmap formatstrings;
110  bool DocumentUseHTML;
111  bool AllowExtendedOptions;
112};
113
114bool is_table_content (const text_t &formatstring);
115bool is_table_content (const format_t *formatlistptr);
116
117bool get_formatstring (const text_t &key, const text_tmap &formatstringmap,
118               text_t &formatstring);
119bool get_formatstring (const text_t &key1, const text_t &key2, 
120               const text_tmap &formatstringmap,
121               text_t &formatstring);
122
123text_t format_date (const text_t &date);
124
125text_t remove_namespace(const text_t &meta_name);
126
127text_t iso639 (const text_t &langcode);
128
129text_t get_href (const text_t &link);
130
131text_t get_related_docs(const text_t& collection, recptproto* collectproto,
132              ResultDocInfo_t &docinfo, ostream& logout);
133
134
135bool parse_formatstring (const text_t &formatstring, format_t *formatlistptr,
136             text_tset &metadata, bool &getParents);
137
138
139
140text_t get_formatted_string (const text_t& collection, recptproto* collectproto,
141                 ResultDocInfo_t &docinfo, displayclass &disp,
142                 format_t *formatlistptr, text_tmap &options,
143                 ostream& logout);
144
145#endif
146
147
Note: See TracBrowser for help on using the browser.