~riaguzov/xpad/add_search

« back to all changes in this revision

Viewing changes to src/xpad-search-bar.c

  • Committer: Siergiej Riaguzow
  • Date: 2019-01-28 22:37:44 UTC
  • Revision ID: siergiej.riaguzow@gmail.com-20190128223744-v5g4flcd1574vat9
Add search via toolbar/context menu/Ctrl-F shortcut

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 
 
3
Copyright (c) 2001-2007 Michael Terry
 
4
Copyright (c) 2019 Siergiej Riaguzow
 
5
 
 
6
This program is free software; you can redistribute it and/or modify
 
7
it under the terms of the GNU General Public License as published by
 
8
the Free Software Foundation; either version 3 of the License, or
 
9
(at your option) any later version.
 
10
 
 
11
This program is distributed in the hope that it will be useful,
 
12
but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
GNU General Public License for more details.
 
15
 
 
16
You should have received a copy of the GNU General Public License
 
17
along with this program; if not, write to the Free Software
 
18
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
19
 
 
20
*/
 
21
 
 
22
#include "../config.h"
 
23
 
 
24
#include <gtk/gtk.h>
 
25
#include <gtksourceview/gtksource.h>
 
26
 
 
27
#include "xpad-search-bar.h"
 
28
 
 
29
struct XpadSearchBarPrivate
 
30
{
 
31
        GtkSourceBuffer *source_buffer;
 
32
        GtkSearchEntry *search_entry;
 
33
        GtkSourceSearchContext *search_context;
 
34
};
 
35
 
 
36
G_DEFINE_TYPE_WITH_PRIVATE (XpadSearchBar, xpad_search_bar, GTK_TYPE_SEARCH_BAR)
 
37
 
 
38
enum
 
39
{
 
40
        PROP_0,
 
41
        PROP_SOURCE_BUFFER,
 
42
        LAST_PROP
 
43
};
 
44
 
 
45
const gchar *EMPTY_STRING = "";
 
46
 
 
47
static void xpad_search_bar_constructed (GObject *object);
 
48
static void xpad_search_bar_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
 
49
static void xpad_search_bar_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
 
50
static void xpad_search_bar_dispose (GObject *object);
 
51
static void xpad_search_bar_finalize (GObject *object);
 
52
static void xpad_search_bar_previous_match_cb(XpadSearchBar *searchbar);
 
53
static void xpad_search_bar_next_match_cb(XpadSearchBar *searchbar);
 
54
static void xpad_search_bar_search_changed_cb(XpadSearchBar *searchbar);
 
55
static void xpad_search_bar_stop_search_cb(XpadSearchBar *searchbar);
 
56
static void reset_search_string(XpadSearchBar *searchbar, const gchar *search_string);
 
57
static void set_not_found_state (XpadSearchBar *searchbar, gboolean is_search_string_not_found);
 
58
 
 
59
XpadSearchBar *
 
60
xpad_search_bar_new (GtkSourceBuffer *buffer)
 
61
{
 
62
        XpadSearchBar *searchbar = g_object_new (XPAD_TYPE_SEARCH_BAR, "source_buffer", buffer, NULL);
 
63
        return searchbar;
 
64
}
 
65
 
 
66
void
 
67
xpad_search_bar_show (XpadSearchBar *searchbar)
 
68
{
 
69
        reset_search_string(searchbar, EMPTY_STRING);
 
70
        gtk_source_search_context_set_highlight (searchbar->priv->search_context, TRUE);
 
71
        gtk_search_bar_set_search_mode (GTK_SEARCH_BAR(searchbar), TRUE);
 
72
}
 
73
 
 
74
void
 
75
xpad_search_bar_hide (XpadSearchBar *searchbar)
 
76
{
 
77
        reset_search_string(searchbar, EMPTY_STRING);
 
78
        gtk_source_search_context_set_highlight (searchbar->priv->search_context, FALSE);
 
79
        gtk_search_bar_set_search_mode (GTK_SEARCH_BAR(searchbar), FALSE);
 
80
}
 
81
 
 
82
static void
 
83
xpad_search_bar_class_init (XpadSearchBarClass *klass)
 
84
{
 
85
        GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 
86
 
 
87
        gobject_class->constructed = xpad_search_bar_constructed;
 
88
        gobject_class->set_property = xpad_search_bar_set_property;
 
89
        gobject_class->get_property = xpad_search_bar_get_property;
 
90
        gobject_class->dispose = xpad_search_bar_dispose;
 
91
        gobject_class->finalize = xpad_search_bar_finalize;
 
92
 
 
93
        g_object_class_install_property (gobject_class,
 
94
                                         PROP_SOURCE_BUFFER,
 
95
                                         g_param_spec_pointer ("source_buffer",
 
96
                                                                        "GtkSourceBuffer",
 
97
                                                                        "GtkSourceBuffer associated with this search bar",
 
98
                                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 
99
}
 
100
 
 
101
 
 
102
static void
 
103
xpad_search_bar_init (XpadSearchBar *searchbar)
 
104
{
 
105
        searchbar->priv = xpad_search_bar_get_instance_private (searchbar);
 
106
        searchbar->priv->search_entry = NULL;
 
107
        searchbar->priv->search_context = NULL;
 
108
}
 
109
 
 
110
static void
 
111
xpad_search_bar_constructed (GObject *object)
 
112
{
 
113
        XpadSearchBar *searchbar = XPAD_SEARCH_BAR (object);
 
114
 
 
115
        // Horizontal box with search_entry and up/down buttons
 
116
        GtkBox *hbox = GTK_BOX (gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0));
 
117
        gtk_box_set_homogeneous (hbox, FALSE);
 
118
        gtk_container_add (GTK_CONTAINER (searchbar), GTK_WIDGET (hbox));
 
119
 
 
120
        // search_entry
 
121
        searchbar->priv->search_entry = GTK_SEARCH_ENTRY (gtk_search_entry_new ());
 
122
        gtk_box_pack_start (hbox, GTK_WIDGET (searchbar->priv->search_entry), TRUE, TRUE, 0);
 
123
 
 
124
        // previous match button
 
125
        GtkButton *prev_search_btn = GTK_BUTTON (gtk_button_new_from_icon_name ("go-up-symbolic", GTK_ICON_SIZE_SMALL_TOOLBAR));
 
126
        gtk_box_pack_start (hbox, GTK_WIDGET (prev_search_btn), FALSE, FALSE, 0);
 
127
 
 
128
        // next match button
 
129
        GtkButton *forward_search_btn = GTK_BUTTON (gtk_button_new_from_icon_name ("go-down-symbolic", GTK_ICON_SIZE_SMALL_TOOLBAR));
 
130
        gtk_box_pack_start (hbox, GTK_WIDGET (forward_search_btn), FALSE, FALSE, 0);
 
131
 
 
132
        // this will allow to for example press Esc without moving the mouse exactly
 
133
        // Sinto the search field to remove the search bar
 
134
        gtk_search_bar_connect_entry (GTK_SEARCH_BAR (searchbar), GTK_ENTRY (searchbar->priv->search_entry));
 
135
 
 
136
        // connecting to GtkSearchEntry signals for actual searching
 
137
        g_signal_connect_swapped (searchbar->priv->search_entry, "stop-search", G_CALLBACK (xpad_search_bar_stop_search_cb), searchbar);
 
138
        g_signal_connect_swapped (searchbar->priv->search_entry, "search-changed", G_CALLBACK (xpad_search_bar_search_changed_cb), searchbar);
 
139
        g_signal_connect_swapped (searchbar->priv->search_entry, "previous-match", G_CALLBACK (xpad_search_bar_previous_match_cb), searchbar);
 
140
        g_signal_connect_swapped (searchbar->priv->search_entry, "next-match", G_CALLBACK (xpad_search_bar_next_match_cb), searchbar);
 
141
        g_signal_connect_swapped (searchbar->priv->search_entry, "activate", G_CALLBACK (xpad_search_bar_next_match_cb), searchbar);
 
142
        g_signal_connect_swapped (prev_search_btn, "clicked", G_CALLBACK (xpad_search_bar_previous_match_cb), searchbar);
 
143
        g_signal_connect_swapped (forward_search_btn, "clicked", G_CALLBACK (xpad_search_bar_next_match_cb), searchbar);
 
144
 
 
145
        // also allow to close by a button on a searchbar (which is implemented in GtkSearchBar itself)
 
146
        // (in gedit search entry dissappears when cursor is moved to text buffer, choosing not to do
 
147
        // the same since it is actually irritating, in case you want to search something, change something,
 
148
        // search again for the same thing. Not adding search and replace since xpad is not a full-blown
 
149
        // text editor, but not hiding search entry when cursor is moved to text buffer is at least a
 
150
        // step in this direction
 
151
        gtk_search_bar_set_show_close_button (GTK_SEARCH_BAR(searchbar), TRUE);
 
152
 
 
153
        // Searchbar should appear in right-top corner of the overlay with text
 
154
        // to not cover the text which is searched (assuming that first
 
155
        // several lines most probably are short enough to not be covered)
 
156
        gtk_widget_set_halign (GTK_WIDGET (searchbar), GTK_ALIGN_END);
 
157
        gtk_widget_set_valign (GTK_WIDGET (searchbar), GTK_ALIGN_START);
 
158
 
 
159
        // Create GtkSearchContext with source buffer as parameter, this will be used for the actual search
 
160
        searchbar->priv->search_context = gtk_source_search_context_new (searchbar->priv->source_buffer, NULL);
 
161
 
 
162
        GtkSourceSearchSettings *settings = gtk_source_search_context_get_settings (searchbar->priv->search_context);
 
163
 
 
164
        // Setting wrap-around to true to ease life. This means that next/prev buttons in searchbar
 
165
        // don't need to be greyed out in case we've reached end of document with forward search
 
166
        // (or beginnig with backward search), they will just wrap arround. If pressing enter
 
167
        // in search entry (which is set to forward search) or pressing next/prev buttons in searchbar
 
168
        // will not find anything we then highlight search entry by red background. This is
 
169
        // similar to gedit where search entry is highlighted in the same way but not after
 
170
        // enter/next/prev are pressed but with complicated logic to do it on the fly (as buffer is
 
171
        // scanned asynchronously there may be a situation when gtk_source_search_context_get_occurrences_count
 
172
        // does not return actual count since it is not counted yet and then they wait for several amount
 
173
        // of time to retry). To avoid this complex logic, wrap-around is set to true to never grey out next/prev
 
174
        // buttons and search entry is highlighted red only if enter/next/prev was pressed and nothing was found
 
175
        // (any change inside search entry will remove this highlight, same for initiating another search)
 
176
        gtk_source_search_settings_set_wrap_around (settings, TRUE);
 
177
}
 
178
 
 
179
static void
 
180
xpad_search_bar_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 
181
{
 
182
        XpadSearchBar *searchbar = XPAD_SEARCH_BAR (object);
 
183
 
 
184
        switch (prop_id)
 
185
        {
 
186
        case PROP_SOURCE_BUFFER:
 
187
                if (G_VALUE_HOLDS_POINTER (value) && G_IS_OBJECT (g_value_get_pointer (value))) {
 
188
                        g_clear_object (&searchbar->priv->source_buffer);
 
189
                        searchbar->priv->source_buffer = g_value_get_pointer (value);
 
190
                        g_object_ref (searchbar->priv->source_buffer);
 
191
                }
 
192
 
 
193
                break;
 
194
 
 
195
        default:
 
196
                G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 
197
                break;
 
198
         }
 
199
}
 
200
 
 
201
static void
 
202
xpad_search_bar_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 
203
{
 
204
        XpadSearchBar *searchbar = XPAD_SEARCH_BAR (object);
 
205
 
 
206
        switch (prop_id)
 
207
        {
 
208
        case PROP_SOURCE_BUFFER:
 
209
                g_value_set_pointer (value, searchbar->priv->source_buffer);
 
210
                break;
 
211
 
 
212
        default:
 
213
                G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 
214
                break;
 
215
        }
 
216
}
 
217
 
 
218
static void
 
219
xpad_search_bar_dispose (GObject *object)
 
220
{
 
221
        XpadSearchBar *searchbar = XPAD_SEARCH_BAR (object);
 
222
 
 
223
        g_clear_object (&searchbar->priv->source_buffer);
 
224
        g_clear_object (&searchbar->priv->search_context);
 
225
 
 
226
        G_OBJECT_CLASS (xpad_search_bar_parent_class)->dispose (object);
 
227
}
 
228
 
 
229
static void
 
230
xpad_search_bar_finalize (GObject *object)
 
231
{
 
232
        G_OBJECT_CLASS (xpad_search_bar_parent_class)->finalize (object);
 
233
}
 
234
 
 
235
static void
 
236
xpad_search_bar_previous_match_cb(XpadSearchBar *searchbar)
 
237
{
 
238
        // reset error highlighting because the text which was not found
 
239
        // might have just appeared (user might have enterd it)
 
240
        set_not_found_state (searchbar, FALSE);
 
241
 
 
242
        GtkTextBuffer *buffer = GTK_TEXT_BUFFER (searchbar->priv->source_buffer);
 
243
 
 
244
        // See comment in xpad_search_bar_next_match_cb, this is exactly the same
 
245
        // but as we are searching backwards this time we look for the beginning
 
246
        // of selection (or in case there is no selection - for the position of cursor
 
247
        // which is equal to both beginning and end of selection)
 
248
        GtkTextIter start;
 
249
        gtk_text_buffer_get_selection_bounds (buffer, &start, NULL);
 
250
 
 
251
        GtkTextIter match_start;
 
252
        GtkTextIter match_end;
 
253
        gboolean *ignore;
 
254
        gboolean found = gtk_source_search_context_backward2 (searchbar->priv->search_context,
 
255
                                                                                                                &start, &match_start, &match_end, ignore);
 
256
        if (found)
 
257
        {
 
258
                gtk_text_buffer_select_range (GTK_TEXT_BUFFER (buffer),
 
259
                                                  &match_start,
 
260
                                                  &match_end);
 
261
        }
 
262
        else
 
263
        {
 
264
                set_not_found_state (searchbar, TRUE);
 
265
        }
 
266
}
 
267
 
 
268
static void
 
269
xpad_search_bar_next_match_cb(XpadSearchBar *searchbar)
 
270
{
 
271
        // reset error highlighting because the text which was not found
 
272
        // might have just appeared (user might have enterd it)
 
273
        set_not_found_state (searchbar, FALSE);
 
274
 
 
275
        GtkTextBuffer *buffer = GTK_TEXT_BUFFER (searchbar->priv->source_buffer);
 
276
 
 
277
        // In case something was selected by ongoing search (pressing next -> next -> next
 
278
        // start will point to the end of selection and next search will start from there,
 
279
        // otherwise (user has moved cursor away from search entry into the text buffer),
 
280
        // start will then point to the exact location of the cursor and next search will
 
281
        // begin from there. This allows to handle situation when user changes text, goes
 
282
        // back to search entry, searches several times, again changes text and so on
 
283
        GtkTextIter start;
 
284
        gtk_text_buffer_get_selection_bounds (buffer, NULL, &start);
 
285
 
 
286
        GtkTextIter match_start;
 
287
        GtkTextIter match_end;
 
288
        gboolean *ignore;
 
289
        gboolean found = gtk_source_search_context_forward2 (searchbar->priv->search_context,
 
290
                                                                                                                &start, &match_start, &match_end, ignore);
 
291
        if (found)
 
292
        {
 
293
                gtk_text_buffer_select_range (GTK_TEXT_BUFFER (buffer),
 
294
                                                  &match_start,
 
295
                                                  &match_end);
 
296
        }
 
297
        else
 
298
        {
 
299
                set_not_found_state (searchbar, TRUE);
 
300
        }
 
301
}
 
302
 
 
303
static void
 
304
xpad_search_bar_search_changed_cb(XpadSearchBar *searchbar)
 
305
{
 
306
        const gchar *text_to_search = gtk_entry_get_text (GTK_ENTRY (searchbar->priv->search_entry));
 
307
        gchar *unescaped_text_to_search = gtk_source_utils_unescape_search_text (text_to_search);
 
308
 
 
309
        reset_search_string (searchbar, unescaped_text_to_search);
 
310
 
 
311
        g_free (unescaped_text_to_search);
 
312
        gtk_source_search_context_set_highlight (searchbar->priv->search_context, TRUE);
 
313
}
 
314
 
 
315
static void
 
316
xpad_search_bar_stop_search_cb(XpadSearchBar *searchbar)
 
317
{
 
318
        xpad_search_bar_hide (searchbar);
 
319
}
 
320
 
 
321
static void
 
322
reset_search_string(XpadSearchBar *searchbar, const gchar *search_string)
 
323
{
 
324
        GtkSourceSearchSettings *settings = gtk_source_search_context_get_settings (searchbar->priv->search_context);
 
325
        gtk_source_search_settings_set_search_text (settings, search_string);
 
326
        set_not_found_state (searchbar, FALSE);
 
327
}
 
328
 
 
329
static void
 
330
set_not_found_state (XpadSearchBar *searchbar, gboolean is_search_string_not_found)
 
331
{
 
332
        GtkStyleContext *context = gtk_widget_get_style_context (GTK_WIDGET (searchbar->priv->search_entry));
 
333
 
 
334
        if (is_search_string_not_found)
 
335
        {
 
336
                gtk_style_context_add_class (context, GTK_STYLE_CLASS_ERROR);
 
337
        }
 
338
        else
 
339
        {
 
340
                gtk_style_context_remove_class (context, GTK_STYLE_CLASS_ERROR);
 
341
        }
 
342
}