Change copyrights from Nokia to Digia
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / parser / qtokenrevealer_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file.  Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights.  These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file.  Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 //
43 //  W A R N I N G
44 //  -------------
45 //
46 // This file is not part of the Qt API.  It exists purely as an
47 // implementation detail.  This header file may change from version to
48 // version without notice, or even be removed.
49 //
50 // We mean it.
51
52 #ifndef Patternist_TokenRevealer_h
53 #define Patternist_TokenRevealer_h
54
55 #include <QSet>
56
57 #include <private/qtokenizer_p.h>
58
59 QT_BEGIN_HEADER
60 QT_BEGIN_NAMESPACE
61
62 namespace QPatternist
63 {
64     /**
65      * @short Delegates another Tokenizer, and while doing so
66      * prints the tokens it delivers to @c stderr.
67      *
68      * Hence, this class is used solely for debugging.
69      *
70      * @since 4.5
71      */
72     class TokenRevealer : public Tokenizer
73     {
74     public:
75         TokenRevealer(const QUrl &uri,
76                       const Tokenizer::Ptr &other);
77
78         virtual ~TokenRevealer();
79
80         virtual Token nextToken(YYLTYPE *const sourceLocator);
81         virtual int commenceScanOnly();
82         virtual void resumeTokenizationFrom(const int position);
83         virtual void setParserContext(const ParserContext::Ptr &parseInfo);
84
85     private:
86         const Tokenizer::Ptr    m_tokenizer;
87         QString                 m_result;
88         QString                 m_indentationString;
89     };
90 }
91
92 QT_END_NAMESPACE
93
94 QT_END_HEADER
95
96 #endif
97