Differential D17459 Diff 47379 src/search/katesearchbar.h

Changeset View

Standalone View

View Options

src/search/katesearchbar.h

Show First 20 Lines • Show All 91 Lines • ▼ Show 20 Line(s)95public Q_SLOTS:
104 * @param replacementPattern the replacement pattern 104​ * @param replacementPattern the replacement pattern
105 */ 105​ */
106 void setReplacementPattern(const QString &replacementPattern); 106​ void setReplacementPattern(const QString &replacementPattern);
107 107​
108 void setSearchMode(SearchMode mode); 108​ void setSearchMode(SearchMode mode);
109 void setSelectionOnly(bool selectionOnly); 109​ void setSelectionOnly(bool selectionOnly);
110 void setMatchCase(bool matchCase); 110​ void setMatchCase(bool matchCase);
111 111​
112 // Called for <F3> and <Shift>+<F3> 112​ // Called by buttons and typically <F3>/<Shift>+<F3> shortcuts
113 void findNext(); 113​ void findNext();
114 void findPrevious(); 114​ void findPrevious();
115 void findAll(); ​
116 115​
116​ // PowerMode stuff
117​ void findAll();
117 void replaceNext(); 118​ void replaceNext();
118 void replaceAll(); 119​ void replaceAll();
119 120​
120 // Also used by KTextEditor::ViewPrivate 121​ // Also used by KTextEditor::ViewPrivate
121 void enterPowerMode(); 122​ void enterPowerMode();
122 void enterIncrementalMode(); 123​ void enterIncrementalMode();
123 124​
124 bool clearHighlights(); 125​ bool clearHighlights();
Show All 10 Lines135private Q_SLOTS:
135 void onIncPatternChanged(const QString &pattern); 136​ void onIncPatternChanged(const QString &pattern);
136 void onMatchCaseToggled(bool matchCase); 137​ void onMatchCaseToggled(bool matchCase);
137 138​
138 void onReturnPressed(); 139​ void onReturnPressed();
139 void updateSelectionOnly(); 140​ void updateSelectionOnly();
140 void updateIncInitCursor(); 141​ void updateIncInitCursor();
141 142​
142 void onPowerPatternChanged(const QString &pattern); 143​ void onPowerPatternChanged(const QString &pattern);
143 ​
144 void onPowerModeChanged(int index); 144​ void onPowerModeChanged(int index);
145 void onPowerPatternContextMenuRequest(); 145​ void onPowerPatternContextMenuRequest();
146 void onPowerPatternContextMenuRequest(const QPoint &); 146​ void onPowerPatternContextMenuRequest(const QPoint &);
147 void onPowerReplacmentContextMenuRequest(); 147​ void onPowerReplacmentContextMenuRequest();
148 void onPowerReplacmentContextMenuRequest(const QPoint &); 148​ void onPowerReplacmentContextMenuRequest(const QPoint &);
149​ void onPowerCancelFindOrReplace();
150​
151​ /**
152​ * This function do the hard search & replace work in time slice steps.
153​ * When all is done @ref m_matchCounter is set and the signal
154​ * @ref findOrReplaceAllFinished() is emitted.
155​ */
156​ void findOrReplaceAll();
157​
158​ /**
159​ * Restore needed settings when signal @ref findOrReplaceAllFinished()
160​ * was received.
161​ */
162​ void endFindOrReplaceAll();
163​
164​Q_SIGNALS:
165​ /**
166​ * Will emitted by @ref findOrReplaceAll() when all is done.
167​ */
168​ void findOrReplaceAllFinished();
149 169​
150private: 170​private:
151 // Helpers 171​ // Helpers
152 bool find(SearchDirection searchDirection = SearchForward, const QString *replacement = nullptr); 172​ bool find(SearchDirection searchDirection = SearchForward) { return findOrReplace(searchDirection, nullptr); };
153 int findAll(KTextEditor::Range inputRange, const QString *replacement); 173​ bool findOrReplace(SearchDirection searchDirection, const QString *replacement);
anthonyfieroniUnsubmitted
Not Done

It's exported class you cannot remove a function, it breaks the ABI

anthonyfieroni: It's exported class you cannot remove a function, it breaks the ABI
174​
175​ /**
176​ * The entry point to start a search & replace task.
177​ * Set needed member variables and call @ref findOrReplaceAll() to do the work.
178​ */
179​ void beginFindOrReplaceAll(KTextEditor::Range inputRange, const QString &replacement, bool replaceMode = true);
180​ void beginFindAll(KTextEditor::Range inputRange) { beginFindOrReplaceAll(inputRange, QString(), false); };
anthonyfieroniUnsubmitted
Not Done

Do not change.

anthonyfieroni: Do not change.
154 181​
155 bool isPatternValid() const; 182​ bool isPatternValid() const;
156 183​
157 KTextEditor::SearchOptions searchOptions(SearchDirection searchDirection = SearchForward) const; 184​ KTextEditor::SearchOptions searchOptions(SearchDirection searchDirection = SearchForward) const;
158 185​
159 void highlightMatch(const KTextEditor::Range &range); 186​ void highlightMatch(const KTextEditor::Range &range);
160 void highlightReplacement(const KTextEditor::Range &range); 187​ void highlightReplacement(const KTextEditor::Range &range);
161 void indicateMatch(MatchResult matchResult); 188​ void indicateMatch(MatchResult matchResult);
162 static void selectRange(KTextEditor::ViewPrivate *view, const KTextEditor::Range &range); 189​ static void selectRange(KTextEditor::ViewPrivate *view, const KTextEditor::Range &range);
163 void selectRange2(const KTextEditor::Range &range); 190​ void selectRange2(const KTextEditor::Range &range);
164 191​
165 QVector<QString> getCapturePatterns(const QString &pattern) const; 192​ QVector<QString> getCapturePatterns(const QString &pattern) const;
166 void showExtendedContextMenu(bool forPattern, const QPoint &pos); 193​ void showExtendedContextMenu(bool forPattern, const QPoint &pos);
167 194​
168 void givePatternFeedback(); 195​ void givePatternFeedback();
169 void addCurrentTextToHistory(QComboBox *combo); 196​ void addCurrentTextToHistory(QComboBox *combo);
170 void backupConfig(bool ofPower); 197​ void backupConfig(bool ofPower);
171 void sendConfig(); 198​ void sendConfig();
172 void fixForSingleLine(KTextEditor::Range &range, SearchDirection searchDirection); 199​ void fixForSingleLine(KTextEditor::Range &range, SearchDirection searchDirection);
173 200​
174 void showInfoMessage(const QString &text); 201​ void showInfoMessage(const QString &text);
anthonyfieroniUnsubmitted
Not Done

Same here.

anthonyfieroni: Same here.
175 202​
176private: 203​private:
177 KTextEditor::ViewPrivate *const m_view; 204​ KTextEditor::ViewPrivate *const m_view;
178 KateViewConfig *const m_config; 205​ KateViewConfig *const m_config;
179 QList<KTextEditor::MovingRange *> m_hlRanges; 206​ QList<KTextEditor::MovingRange *> m_hlRanges;
180 QPointer<KTextEditor::Message> m_infoMessage; 207​ QPointer<KTextEditor::Message> m_infoMessage;
181 QPointer<KTextEditor::Message> m_wrappedMessage; 208​ QPointer<KTextEditor::Message> m_wrappedMessage;
182 SearchDirection m_lastSearchDirection = SearchForward; 209​ SearchDirection m_lastSearchDirection = SearchForward;
183 210​
184 // Shared by both dialogs 211​ // Shared by both dialogs
185 QVBoxLayout *const m_layout; 212​ QVBoxLayout *const m_layout;
186 QWidget *m_widget; 213​ QWidget *m_widget;
187 214​
188 // Incremental search related 215​ // Incremental search related
189 Ui::IncrementalSearchBar *m_incUi; 216​ Ui::IncrementalSearchBar *m_incUi;
190 KTextEditor::Cursor m_incInitCursor; 217​ KTextEditor::Cursor m_incInitCursor;
191 218​
192 // Power search related 219​ // Power search related
193 Ui::PowerSearchBar *m_powerUi; 220​ Ui::PowerSearchBar *m_powerUi = nullptr;
221​ KTextEditor::Range m_inputRange;
222​ QString m_replacement;
223​ uint m_matchCounter = 0;
224​ bool m_replaceMode = false;
225​ bool m_cancelFindOrReplace = false;
226​ std::vector<KTextEditor::Range> m_highlightRanges;
194 227​
anthonyfieroniUnsubmitted
Not Done

You cannot add new members as well, they change object size. Since this class not use pimpl idiom it will be harder to change anything in header except to add new non-virtual functions.

anthonyfieroni: You cannot add new members as well, they change object size. Since this class not use pimpl…
cullmannUnsubmitted
Not Done

This is a purely internal class.
It is only exported for the unit tests, no header files are installed, therefore any change of the layout is ok ;=)

cullmann: This is a purely internal class. It is only exported for the unit tests, no header files are…
dhaumannUnsubmitted
Not Done

Yes: as rule of thumb: only classes in the KTextEditor namespace are public API. Everything else can be freely changed. In this case, as Christoph points out, this is purely internal API.

PS: maybe we should have a KTEXTEDITOR_TEST_EXPORT macro to make this explicit. :-)

dhaumann: Yes: as rule of thumb: only classes in the KTextEditor namespace are public API. Everything…
195 // attribute to highlight matches with 228​ // attribute to highlight matches with
196 KTextEditor::Attribute::Ptr highlightMatchAttribute; 229​ KTextEditor::Attribute::Ptr highlightMatchAttribute;
197 KTextEditor::Attribute::Ptr highlightReplacementAttribute; 230​ KTextEditor::Attribute::Ptr highlightReplacementAttribute;
198 231​
199 // Status backup 232​ // Status backup
200 bool m_incHighlightAll : 1; 233​ bool m_incHighlightAll : 1;
201 bool m_incFromCursor : 1; 234​ bool m_incFromCursor : 1;
202 bool m_incMatchCase : 1; 235​ bool m_incMatchCase : 1;
203 bool m_powerMatchCase : 1; 236​ bool m_powerMatchCase : 1;
204 bool m_powerFromCursor : 1; 237​ bool m_powerFromCursor : 1;
205 bool m_powerHighlightAll : 1; 238​ bool m_powerHighlightAll : 1;
206 unsigned int m_powerMode : 2; 239​ unsigned int m_powerMode : 2;
207}; 240​};
208 241​
209#endif // KATE_SEARCH_BAR_H 242​#endif // KATE_SEARCH_BAR_H
210 243​
Context not available.