summaryrefslogtreecommitdiffstats
path: root/tools/qdoc3/quoter.h
blob: 6a59ab482a255b502e7583611ce4dd06a8af18bf (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
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*
  quoter.h
*/

#ifndef QUOTER_H
#define QUOTER_H

#include <qhash.h>
#include <qstringlist.h>

#include "location.h"

QT_BEGIN_NAMESPACE

class Quoter
{
public:
    Quoter();

    void reset();
    void quoteFromFile( const QString& userFriendlyFileName,
			const QString& plainCode, const QString& markedCode );
    QString quoteLine( const Location& docLocation, const QString& command,
		       const QString& pattern );
    QString quoteTo( const Location& docLocation, const QString& command,
		     const QString& pattern );
    QString quoteUntil( const Location& docLocation, const QString& command,
			const QString& pattern );
    QString quoteSnippet(const Location &docLocation, const QString &identifier);

private:
    QString getLine(int unindent = 0);
    void failedAtEnd( const Location& docLocation, const QString& command );
    bool match( const Location& docLocation, const QString& pattern,
    		const QString& line );
    QString commentForCode() const;
    QString removeSpecialLines(const QString &line, const QString &comment,
                               int unindent = 0);

    bool silent; 
    bool validRegExp;
    QStringList plainLines;
    QStringList markedLines;
    Location codeLocation;
    QHash<QString,QString> commentHash;
};

QT_END_NAMESPACE

#endif