1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2015 The Qt Company Ltd. 4 ** Contact: http://www.qt.io/licensing/ 5 ** 6 ** This file is part of the tools applications 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 The Qt Company. For licensing terms 14 ** and conditions see http://www.qt.io/terms-conditions. For further 15 ** information use the contact form at http://www.qt.io/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 or version 3 as published by the Free 20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and 21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the 22 ** following information to ensure the GNU Lesser General Public License 23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and 24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. 25 ** 26 ** As a special exception, The Qt Company gives you certain additional 27 ** rights. These rights are described in The Qt Company LGPL Exception 28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. 29 ** 30 ** GNU General Public License Usage 31 ** Alternatively, this file may be used under the terms of the GNU 32 ** General Public License version 3.0 as published by the Free Software 33 ** Foundation and appearing in the file LICENSE.GPL included in the 34 ** packaging of this file. Please review the following information to 35 ** ensure the GNU General Public License version 3.0 requirements will be 36 ** met: http://www.gnu.org/copyleft/gpl.html. 37 ** 38 ** $QT_END_LICENSE$ 39 ** 40 ****************************************************************************/ 41 42 /* 43 quoter.h 44 */ 45 46 #ifndef QUOTER_H 47 #define QUOTER_H 48 49 #include <qhash.h> 50 #include <qstringlist.h> 51 52 #include "location.h" 53 54 QT_BEGIN_NAMESPACE 55 56 class Quoter 57 { 58 public: 59 Quoter(); 60 61 void reset(); 62 void quoteFromFile( const QString& userFriendlyFileName, 63 const QString& plainCode, const QString& markedCode ); 64 QString quoteLine( const Location& docLocation, const QString& command, 65 const QString& pattern ); 66 QString quoteTo( const Location& docLocation, const QString& command, 67 const QString& pattern ); 68 QString quoteUntil( const Location& docLocation, const QString& command, 69 const QString& pattern ); 70 QString quoteSnippet(const Location &docLocation, const QString &identifier); 71 72 static QStringList splitLines(const QString &line); 73 74 private: 75 QString getLine(int unindent = 0); 76 void failedAtEnd( const Location& docLocation, const QString& command ); 77 bool match( const Location& docLocation, const QString& pattern, 78 const QString& line ); 79 QString commentForCode() const; 80 QString removeSpecialLines(const QString &line, const QString &comment, 81 int unindent = 0); 82 83 bool silent; 84 bool validRegExp; 85 QStringList plainLines; 86 QStringList markedLines; 87 Location codeLocation; 88 QHash<QString,QString> commentHash; 89 }; 90 91 QT_END_NAMESPACE 92 93 #endif 94