summaryrefslogtreecommitdiff
path: root/src/rtfparser.h
blob: 6b9e10dfad5b9c0b3095e42b48b6438b1f047e5e (plain)
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
/*
 * Copyright (c) 2004, Nate Nielsen
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *     * Redistributions of source code must retain the above
 *       copyright notice, this list of conditions and the
 *       following disclaimer.
 *     * Redistributions in binary form must reproduce the
 *       above copyright notice, this list of conditions and
 *       the following disclaimer in the documentation and/or
 *       other materials provided with the distribution.
 *     * The names of contributors to this software may not be
 *       used to endorse or promote products derived from this
 *       software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 *
 * CONTRIBUTORS
 *  Nate Nielsen <nielsen@memberwebs.com>
 *
 */

// RENAME RTFParser.h

#ifndef __RTFREADER_H__
#define __RTFREADER_H__

#include "usuals.h"
#include <stack>
#include <stdio.h>

class RtfHandler;

/*
 * RTFParser
 *
 * A class that parses the RTF into it's tags and groups etc... It feeds its
 * parsed data into into a handler interface (see below) for processing.
 *
 * Performs some basic conversion and sanity checking (unicode chars etc...)
 * as well.
 */
class RtfParser
{
public:
	RtfParser();
	virtual ~RtfParser();

	bool parse(string fileName);
	bool parse(FILE* file);

	void setHandler(RtfHandler* handler)
		{ m_handler = handler; }
	string getParseErrors() const
		{ return m_parseErrors; }
	int getDepth() const
		{ return m_depth; }
	void setHexParse(bool parse)
		{ m_parseHex = parse; }
	void setUnicode(bool unicode);

protected:
	RtfHandler* m_handler;         // The current handler
	int m_depth;                   // To keep track of group depth
	bool m_parseHex;               // Whether to parse hex chars or not
	string m_parseErrors;          // A list of all the RTF parsing errors

    // TODO: Look at exactly what this is doing
    // Unicode char handling
	bool m_parseUnicode;
	typedef std::stack<int> StackInt;
	StackInt m_uniEatStack;
	int m_uniEat;

private:

    // TODO: Why aren't these just members?

	struct RtfContext
	{
		FILE* file;       // The current file being parsed
		wstring data;     // Any data stored up ready to be sent to handler
        bool isData;      // TODO: Do we need this?
	};

    // Parse helpers
	bool parseControlWord(RtfContext& cx);
	bool parseHexChar(RtfContext& cx, int num);

    // Convenience functions for calling the handler
	void sendControlWord(RtfContext& cx, string cw, int flags, int param);
	void sendData(RtfContext& cx, wchar_t ch);
	void sendData(RtfContext& cx, wstring data);
	void flushData(RtfContext& cx);
};

/*
 * RTFHandler
 *
 * An interface called by RTFParser with tags and groups etc... parsed from
 * an RTF file.
 */
class RtfHandler
{
public:

    // Called at the beginning of the document
    virtual void startDocument(RtfReader* reader) = 0;

    // Called at the end of the document
    virtual void endDocument() = 0;

    // Called when an RTF control word is hit. Flags below.
    // If control word has no param then param is -1
    virtual void controlWord(const string& cw, int flags, int param) = 0;

    // Called when an RTF group opened
    virtual void groupStart() = 0;

    // Called when an RTF group is closed
    virtual void groupEnd() = 0;

    // A block of character data encountered
    virtual void charData(wstring data) = 0;

    // Flags for controlWord
    enum
    {
        kAsterisk = 0x00000001,
        kHasParam = 0x00000002,
        kIsEncoded = 0x00000004
    };
};

#endif // __RTFREADER_H__