[go: up one dir, main page]

File: tohtml.h

package info (click to toggle)
tora 1.3.4-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 8,632 kB
  • ctags: 7,487
  • sloc: cpp: 68,518; perl: 1,475; ansic: 291; sh: 173; makefile: 51
file content (178 lines) | stat: -rw-r--r-- 5,496 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
//***************************************************************************
/*
 * TOra - An Oracle Toolkit for DBA's and developers
 * Copyright (C) 2000-2001,2001 Underscore AB
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation;  only version 2 of
 * the License is valid for this program.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 *      As a special exception, you have permission to link this program
 *      with the Oracle Client libraries and distribute executables, as long
 *      as you follow the requirements of the GNU GPL in regard to all of the
 *      software in the executable aside from Oracle client libraries.
 *
 *      Specifically you are not permitted to link this program with the
 *      Qt/UNIX, Qt/Windows or Qt Non Commercial products of TrollTech.
 *      And you are not permitted to distribute binaries compiled against
 *      these libraries without written consent from Underscore AB. Observe
 *      that this does not disallow linking to the Qt Free Edition.
 *
 * All trademarks belong to their respective owners.
 *
 ****************************************************************************/

#ifndef TOHTML_H
#define TOHTML_H

#include <map>

#include <qstring.h>
#include <qcstring.h>

#define TO_HTML_MAX_QUAL 100

/** A small and hopefully pretty efficient parser of HTML tags. No attempt what
 * so ever is made trying to check the validity of the text so if you forget
 * a closing > you will probably end up with an exception.
 *
 * A simple traverser counting the number of paragraphs might look like this.
 *
<pre>
int paragraphs++;
toHtml count("Paragraphs<P>And some</P><P>Dobedoo");
while(!count.eof()) {
  count.nextToken();
  if (count.isTag()&&count.open()&&QString(count.tag())=="p")
    paragraphs++;
}
</pre>
 */

class toHtml {
  /** Actual data of file.
   */
  char *Data;
  /** Length of the data.
   */
  size_t Length;
  /** Current position in data.
   */
  size_t Position;

  /** Last character that was at the end of text written over by call to @ref mid.
   * This is a real cludge, but what don't you do for performance.
   */
  char LastChar;

  /** List of qualifiers for tab. This is not a list because of performance as well.
   * Not really a lot of memory wasted this way, in fact it is probably more efficient
   * than a dynamic list.
   */
  struct {
    /** Name of qualifier. Always lowercase, points into @ref Data.
     */
    const char *Name;
    /** Value of qualifier. Points into @ref Data.
     */
    const char *Value;
  } Qualifiers[TO_HTML_MAX_QUAL];

  /** Number of qualifiers used.
   */
  int QualifierNum;
  /** If last token read was a tag or plain text.
   */
  bool IsTag;
  /** Last tag read was an open tag. Only valid if @ref isTag is true.
   */
  bool Open;
  /** Name of tag. NULL terminated, points into @ref Data.
   */
  const char *Tag;
  /** Text if not tag. NULL terminated, points into @ref Data.
   */
  const char *Text;

  /** Walk forward in @ref Data until not whitespace.
   */
  void skipSpace(void);
  /** Extract a string from @ref Data. Insert 0 at end of string, store overwritten char
   * in LastChar.
   * @param start Start position of string to extract.
   * @param size Size of string to extract.
   * @return Pointer to string (Points into @ref Data)
   */
  const char *mid(size_t start,size_t size);
public:
  /** Create a HTML parser.
   * @param data Data to parse.
   */
  toHtml(const QCString &data);
  ~toHtml();

  /** Read the next token which can be either a open tag, close tag or text.
   *
   * Observe that nextToken destroys the data it has parsed, so you
   * can't search it later. Searhing must be done on an new toHtml,
   * several serches can be made though on the same toHtml.
   */

  void nextToken(void);

  /** Get value of a qualifier.
   * @param name Name of qualifier in lowercase.
   * @return Value of qualifier or NULL.
   */
  const char *value(const QCString &name);
  /** Return true if current token is a tag.
   * @return True if tag.
   */
  bool isTag(void)
  { return IsTag; }
  /** Return true if open tag. Only valid if @ref isTag is true.
   * @return True if open tag.
   */
  bool open(void)
  { return Open; }

  /** Get bread text if available. Expands &# characters are expanded before returned.
   * Only valid if @ref isTag returns false.
   * @return The parsed text.
   */

  QCString text(void);

  /** Get name of tag in lowercase. Only valid if @ref isTag returns true.
   * @return Name of tag (Excluding / if close tag).
   */
  const char *tag(void)
  { return Tag; }

  /** Check if at end of data
   * @return True if at end of data.
   */
  bool eof(void);

  /** Search data for a simple text.
   * @param data Data to search.
   * @param str Substring to search for in data.
   */
  static bool search(const QCString &data,const QString &str);

  /** Escape text to be HTML.
   */
  static QString escape(const QString &html);
};

#endif