summaryrefslogtreecommitdiffstats
path: root/experimental/tqtinterface/qt4/tools/assistant/docuparser.h
blob: 0ca4d6167836e37c6b98adc853c2d1bfeb155ed3 (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) 2000-2008 Trolltech ASA.  All rights reserved.
**
** This file is part of the TQt Assistant.
**
** This file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free
** Software Foundation and appearing in the files LICENSE.GPL2
** and LICENSE.GPL3 included in the packaging of this file.
** Alternatively you may (at your option) use any later version
** of the GNU General Public License if such license has been
** publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free TQt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing requirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at sales@trolltech.com.
**
** Licensees holding valid TQt Commercial licenses may use this file in
** accordance with the TQt Commercial License Agreement provided with
** the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

#ifndef DOCUPARSER_H
#define DOCUPARSER_H

#include <tqxml.h>
#include <tqptrlist.h>
#include <tqmap.h>

class Profile;

struct ContentItem {
    ContentItem()
	: title( TQString() ), reference( TQString() ), depth( 0 ) {}
    ContentItem( const TQString &t, const TQString &r, int d )
	: title( t ), reference( r ), depth( d ) {}
    TQString title;
    TQString reference;
    int depth;
    TQ_DUMMY_COMPARISON_OPERATOR(ContentItem)
};

TQDataStream &operator>>( TQDataStream &s, ContentItem &ci );
TQDataStream &operator<<( TQDataStream &s, const ContentItem &ci );

struct IndexItem {
    IndexItem( const TQString &k, const TQString &r )
	: keyword( k ), reference( r ) {}
    TQString keyword;
    TQString reference;
};



class DocuParser : public TQXmlDefaultHandler
{
public:
    enum ParserVersion { TQt310, TQt320 };
    // Since We don't want problems with documentation
    // from version to version, this string stores the correct
    // version string to save documents.
    static const TQString DocumentKey;

    static DocuParser *createParser( const TQString &fileName );

    virtual bool parse( TQFile *file );
    
    TQValueList<ContentItem> getContentItems();
    TQPtrList<IndexItem> getIndexItems();

    TQString errorProtocol() const;
    TQString contentsURL() const { return conURL; }

    virtual ParserVersion parserVersion() const = 0;
    virtual void addTo( Profile *p ) = 0;

    TQString fileName() const { return fname; }
    void setFileName( const TQString &file ) { fname = file; }

protected:
    TQString absolutify( const TQString &input ) const;
    
    TQString contentRef, indexRef, errorProt, conURL;
    TQString docTitle, title, iconName;
    TQValueList<ContentItem> contentList;
    TQPtrList<IndexItem> indexList;
    TQString fname;
};


class DocuParser310 : public DocuParser
{
public:
    enum States{ StateInit, StateContent, StateSect, StateKeyword };
    
    bool startDocument();
    bool startElement( const TQString&, const TQString&, const TQString& ,
                       const TQXmlAttributes& );
    bool endElement( const TQString&, const TQString&, const TQString& );
    bool characters( const TQString & );
    bool fatalError( const TQXmlParseException& exception );

    virtual ParserVersion parserVersion() const { return TQt310; }
    virtual void addTo( Profile *p );
    
private:
    States state;
    int depth;
};


class DocuParser320 : public DocuParser
{
public:
    enum States { StateInit, StateDocRoot, StateProfile, StateProperty,
		  StateContent, StateSect, StateKeyword };

    DocuParser320();    
    
    bool startDocument();
    bool startElement( const TQString&, const TQString&, const TQString& ,
                       const TQXmlAttributes& );
    bool endElement( const TQString&, const TQString&, const TQString& );
    bool characters( const TQString & );
    bool fatalError( const TQXmlParseException& exception );

    virtual ParserVersion parserVersion() const { return TQt320; }
    virtual void addTo( Profile *p );
    Profile *profile() const { return prof; }    

private:
    
    States state;
    int depth;
    int docfileCounter;
    TQString propertyValue;
    TQString propertyName;
    Profile *prof;
};
#endif //DOCUPARSER_H