Skip to content

SearchToolbar: Modernise, prepare for Gtk4 #880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeremypw merged 9 commits into from
Aug 7, 2025
Merged

SearchToolbar: Modernise, prepare for Gtk4 #880

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ed57484
Update header
jeremypw Jul 31, 2025
4d8422b
Inline namespace
jeremypw Jul 31, 2025
796bdfa
Modernise child widget construction
jeremypw Jul 31, 2025
41712a9
Merge branch 'master' into jeremypw/searchtoolbar/gtk4prep
jeremypw Jul 31, 2025
4fa609b
Correct license
jeremypw Jul 31, 2025
42aae1c
Copyright from 2011
jeremypw Jul 31, 2025
816ecb7
Remove unneeded parens
jeremypw Jul 31, 2025
b0ef565
Remove more unneeded parens
jeremypw Jul 31, 2025
8ecfc1b
Merge branch 'master' into jeremypw/searchtoolbar/gtk4prep
jeremypw Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
260 changes: 123 additions & 137 deletions src/Widgets/SearchToolbar.vala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,145 +1,131 @@
// -*- Mode: vala; indent-tabs-mode: nil; tab-width: 4 -*-
/*
* Copyright (c) 2011-2017 elementary LLC. (https://elementary.io)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 3 as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA
*/

namespace Terminal.Widgets {

public class SearchToolbar : Gtk.Box {
private Gtk.ToggleButton cycle_button;
private uint last_search_term_length = 0;

public weak MainWindow window { get; construct; }
public Gtk.SearchEntry search_entry;

public SearchToolbar (MainWindow window) {
Object (window: window);
}

construct {
search_entry = new Gtk.SearchEntry ();
search_entry.hexpand = true;
search_entry.placeholder_text = _("Find");

var previous_button = new Gtk.Button.from_icon_name ("go-up-symbolic");
previous_button.set_action_name (MainWindow.ACTION_PREFIX + MainWindow.ACTION_SEARCH_PREVIOUS);
previous_button.tooltip_markup = Granite.markup_accel_tooltip (
* SPDX-License-Identifier: LGPL-3.0-or-later
* SPDX-FileCopyrightText: 2011-2025 elementary, Inc. (https://elementary.io)
*/

public class Terminal.Widgets.SearchToolbar : Gtk.Box {
private Gtk.ToggleButton cycle_button;
private uint last_search_term_length = 0;

public weak MainWindow window { get; construct; }
public Gtk.SearchEntry search_entry;

public SearchToolbar (MainWindow window) {
Object (window: window);
}

construct {
search_entry = new Gtk.SearchEntry () {
hexpand = true,
placeholder_text = _("Find")
};

var previous_button = new Gtk.Button.from_icon_name ("go-up-symbolic") {
action_name = MainWindow.ACTION_PREFIX + MainWindow.ACTION_SEARCH_PREVIOUS,
tooltip_markup = Granite.markup_accel_tooltip (
{"<Control>Up", "<Control><Shift>g"},
_("Previous result")
);
)
};

var next_button = new Gtk.Button.from_icon_name ("go-down-symbolic");
next_button.set_action_name (MainWindow.ACTION_PREFIX + MainWindow.ACTION_SEARCH_NEXT);
next_button.tooltip_markup = Granite.markup_accel_tooltip (
var next_button = new Gtk.Button.from_icon_name ("go-down-symbolic") {
action_name = MainWindow.ACTION_PREFIX + MainWindow.ACTION_SEARCH_NEXT,
tooltip_markup = Granite.markup_accel_tooltip (
{"<Control>Down", "<Control>g"},
_("Next result")
);

cycle_button = new Gtk.ToggleButton () {
active = false,
sensitive = false,
image = new Gtk.Image ()
};
cycle_button.toggled.connect (() => {
if (cycle_button.active) {
cycle_button.tooltip_text = _("Disable cyclic search");
((Gtk.Image)cycle_button.image).icon_name = "media-playlist-repeat-symbolic";
} else {
cycle_button.tooltip_text = _("Enable cyclic search");
((Gtk.Image)cycle_button.image).icon_name = "media-playlist-repeat-disabled-symbolic";
}
});
// Toggle to update
// TODO Restore state from settings
cycle_button.toggled ();

get_style_context ().add_class (Gtk.STYLE_CLASS_LINKED);
add (search_entry);
add (next_button);
add (previous_button);
add (cycle_button);

show_all ();

grab_focus.connect (() => {
search_entry.grab_focus_without_selecting ();
});

next_button.clicked.connect_after (() => {
grab_focus ();
});

previous_button.clicked.connect_after (() => {
grab_focus ();
});

cycle_button.clicked.connect_after (() => {
grab_focus ();
});

search_entry.search_changed.connect (() => {
if (search_entry.text != "") {
window.get_simple_action (MainWindow.ACTION_SEARCH_NEXT).set_enabled (true);
window.get_simple_action (MainWindow.ACTION_SEARCH_PREVIOUS).set_enabled (true);
cycle_button.sensitive = true;
} else {
window.get_simple_action (MainWindow.ACTION_SEARCH_NEXT).set_enabled (false);
window.get_simple_action (MainWindow.ACTION_SEARCH_PREVIOUS).set_enabled (false);
cycle_button.sensitive = false;
}

var term = (Vte.Terminal)(window.current_terminal);
var search_term = search_entry.text;
previous_search (); /* Ensure that we still at the highlighted occurrence */

if (last_search_term_length > search_term.length) {
term.match_remove_all ();
term.unselect_all (); /* Ensure revised search finds first occurrence first*/
}

last_search_term_length = search_term.length;

try {
// FIXME Have a configuration menu or something.
/* NOTE Using a Vte.Regex leads and Vte.Terminal.search_set_regex leads to
* a "PCRE2 not supported" error.
*/
var regex = new Vte.Regex.for_search (GLib.Regex.escape_string (search_term), -1, PCRE2.Flags.CASELESS | PCRE2.Flags.MULTILINE);
term.search_set_regex (regex, 0);
next_search (); /* Search immediately - not after ENTER pressed */
} catch (Error er) {
warning ("There was an error to compile the regex: %s", er.message);
}
});
}

public void clear () {
search_entry.text = "";
last_search_term_length = 0;
}

public void previous_search () {
window.current_terminal.search_set_wrap_around (cycle_button.active);
window.current_terminal.search_find_previous ();
}

public void next_search () {
window.current_terminal.search_set_wrap_around (cycle_button.active);
window.current_terminal.search_find_next ();
}
)
};

cycle_button = new Gtk.ToggleButton () {
active = false,
sensitive = false,
image = new Gtk.Image ()
};
cycle_button.toggled.connect (() => {
if (cycle_button.active) {
cycle_button.tooltip_text = _("Disable cyclic search");
((Gtk.Image)cycle_button.image).icon_name = "media-playlist-repeat-symbolic";
} else {
cycle_button.tooltip_text = _("Enable cyclic search");
((Gtk.Image)cycle_button.image).icon_name = "media-playlist-repeat-disabled-symbolic";
}
});
// Toggle to update
// TODO Restore state from settings
cycle_button.toggled ();

get_style_context ().add_class (Gtk.STYLE_CLASS_LINKED);
add (search_entry);
add (next_button);
add (previous_button);
add (cycle_button);

show_all ();

grab_focus.connect (() => {
search_entry.grab_focus_without_selecting ();
});

next_button.clicked.connect_after (() => {
grab_focus ();
});

previous_button.clicked.connect_after (() => {
grab_focus ();
});

cycle_button.clicked.connect_after (() => {
grab_focus ();
});

search_entry.search_changed.connect (() => {
if (search_entry.text != "") {
window.get_simple_action (MainWindow.ACTION_SEARCH_NEXT).set_enabled (true);
window.get_simple_action (MainWindow.ACTION_SEARCH_PREVIOUS).set_enabled (true);
cycle_button.sensitive = true;
} else {
window.get_simple_action (MainWindow.ACTION_SEARCH_NEXT).set_enabled (false);
window.get_simple_action (MainWindow.ACTION_SEARCH_PREVIOUS).set_enabled (false);
cycle_button.sensitive = false;
}

var term = (Vte.Terminal)(window.current_terminal);
var search_term = search_entry.text;
previous_search (); /* Ensure that we still at the highlighted occurrence */

if (last_search_term_length > search_term.length) {
term.match_remove_all ();
term.unselect_all (); /* Ensure revised search finds first occurrence first*/
}

last_search_term_length = search_term.length;

try {
// FIXME Have a configuration menu or something.
/* NOTE Using a Vte.Regex leads and Vte.Terminal.search_set_regex leads to
* a "PCRE2 not supported" error.
*/
var regex = new Vte.Regex.for_search (GLib.Regex.escape_string (search_term), -1, PCRE2.Flags.CASELESS | PCRE2.Flags.MULTILINE);
term.search_set_regex (regex, 0);
next_search (); /* Search immediately - not after ENTER pressed */
} catch (Error er) {
warning ("There was an error to compile the regex: %s", er.message);
}
});
}

public void clear () {
search_entry.text = "";
last_search_term_length = 0;
}

public void previous_search () {
window.current_terminal.search_set_wrap_around (cycle_button.active);
window.current_terminal.search_find_previous ();
}

public void next_search () {
window.current_terminal.search_set_wrap_around (cycle_button.active);
window.current_terminal.search_find_next ();
}
}