Differential D23457 Diff 71059 src/search/kateregexpsearch.h

Changeset View

Standalone View

View Options

src/search/kateregexpsearch.h

Show All 17 Lines1/* SPDX-License-Identifier: LGPL-2.0-or-later
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 18​ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA. 19​ Boston, MA 02110-1301, USA.
20*/ 20​*/
21 21​
22#ifndef _KATE_REGEXPSEARCH_H_ 22​#ifndef _KATE_REGEXPSEARCH_H_
23#define _KATE_REGEXPSEARCH_H_ 23​#define _KATE_REGEXPSEARCH_H_
24 24​
25#include <QObject> 25​#include <QObject>
26​#include <QRegularExpression>
26 27​
27#include <ktexteditor/range.h> 28​#include <ktexteditor/range.h>
28 29​
29#include <ktexteditor_export.h> 30​#include <ktexteditor_export.h>
30 31​
31namespace KTextEditor 32​namespace KTextEditor
32{ 33​{
33class Document; 34​class Document;
34} 35​}
35 36​
36/** 37​/**
37 * Object to help to search for regexp. 38​ * Object to help to search for regexp.
38 * This should be NO QObject, it is created to often! 39​ * This should be NO QObject, it is created to often!
39 * I measured that, if you create it 20k times to replace for example " " in a document, that takes seconds on a modern machine! 40​ * I measured that, if you create it 20k times to replace for example " " in a document, that takes seconds on a modern machine!
40 */ 41​ */
41class KTEXTEDITOR_EXPORT KateRegExpSearch 42​class KTEXTEDITOR_EXPORT KateRegExpSearch
42{ 43​{
43public: 44​public:
44 explicit KateRegExpSearch(const KTextEditor::Document *document, Qt::CaseSensitivity caseSensitivity); 45​ explicit KateRegExpSearch(const KTextEditor::Document *document);
45 ~KateRegExpSearch(); 46​ ~KateRegExpSearch();
46 47​
47 // 48​ //
48 // KTextEditor::SearchInterface stuff 49​ // KTextEditor::SearchInterface stuff
49 // 50​ //
50public: 51​public:
51 /** 52​ /**
52 * Search for the regular expression \p pattern inside the range 53​ * Search for the regular expression \p pattern inside the range
53 * \p inputRange. If \p backwards is \e true, the search direction will 54​ * \p inputRange. If \p backwards is \e true, the search direction will
54 * be reversed. 55​ * be reversed. \p options is a set of QRegularExpression::PatternOptions
56​ * OR flags that control certain aspects of the search, e.g. case
57​ * sensitivity and if the dot "." metacharacter matches any character
58​ * including a newline.
55 * 59​ *
56 * \param pattern text to search for 60​ * \param pattern text to search for
57 * \param inputRange Range to search in 61​ * \param inputRange Range to search in
58 * \param backwards if \e true, the search will be backwards 62​ * \param backwards if \e true, the search will be backwards
63​ * \param options QRegularExpression pattern options
59 * \return Vector of ranges, one for each capture. The first range (index zero) 64​ * \return Vector of ranges, one for each capture. The first range (index zero)
60 * spans the full match. If the pattern does not match the vector 65​ * spans the full match. If the pattern does not match, the vector
61 * has length 1 and holds the invalid range (see Range::isValid()). 66​ * will contain one element, an invalid range (see Range::isValid()).
62 * \see KTextEditor::Range, QRegularExpression 67​ * \see KTextEditor::Range, QRegularExpression
63 */ 68​ */
64 QVector<KTextEditor::Range> search(const QString &pattern, const KTextEditor::Range &inputRange, bool backwards = false); 69​ QVector<KTextEditor::Range> search(const QString &pattern,
70​ const KTextEditor::Range &inputRange,
71​ bool backwards = false,
72​ QRegularExpression::PatternOptions options =
73​ QRegularExpression::NoPatternOption);
65 74​
66 /** 75​ /**
67 * Returns a modified version of text where escape sequences are resolved, e.g. "\\n" to "\n". 76​ * Returns a modified version of text where escape sequences are resolved, e.g. "\\n" to "\n".
68 * 77​ *
69 * \param text text containing escape sequences 78​ * \param text text containing escape sequences
70 * \return text with resolved escape sequences 79​ * \return text with resolved escape sequences
71 */ 80​ */
72 static QString escapePlaintext(const QString &text); 81​ static QString escapePlaintext(const QString &text);
Show All 18 Lines96private:
91 * \param text text containing escape sequences and possibly references and counters 100​ * \param text text containing escape sequences and possibly references and counters
92 * \param capturedTexts list of substitutes for references 101​ * \param capturedTexts list of substitutes for references
93 * \param replacementCounter value for replacement counter (only used when replacementGoodies == true) 102​ * \param replacementCounter value for replacement counter (only used when replacementGoodies == true)
94 * \param replacementGoodies @c true for buildReplacement(), @c false for escapePlainText() 103​ * \param replacementGoodies @c true for buildReplacement(), @c false for escapePlainText()
95 * \return resolved text 104​ * \return resolved text
96 */ 105​ */
97 static QString buildReplacement(const QString &text, const QStringList &capturedTexts, int replacementCounter, bool replacementGoodies); 106​ static QString buildReplacement(const QString &text, const QStringList &capturedTexts, int replacementCounter, bool replacementGoodies);
98 107​
108​ /**
109​ * States, whether the pattern could match multiple lines.
110​ */
111​ bool isMultiLine(const QString &pattern) const;
112​
99private: 113​private:
100 const KTextEditor::Document *const m_document; 114​ const KTextEditor::Document *const m_document;
101 Qt::CaseSensitivity m_caseSensitivity; 115​ Qt::CaseSensitivity m_caseSensitivity;
102 class ReplacementStream; 116​ class ReplacementStream;
103}; 117​};
104 118​
105#endif 119​#endif