// This file Copyright © Mnemosyne LLC. // It may be used under GPLv2 (SPDX: GPL-2.0-only), GPLv3 (SPDX: GPL-3.0-only), // or any future license endorsed by Mnemosyne LLC. // License text can be found in the licenses/ folder. #pragma once #include "GtkCompat.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #if GTKMM_CHECK_VERSION(4, 0, 0) #include #endif #include #include #include #include #include #include #include #include #include #include #include /*** **** ***/ void gtr_message(std::string const& message); void gtr_warning(std::string const& message); void gtr_error(std::string const& message); /*** **** ***/ enum class GtrUnicode : uint8_t { Up, Down, Inf, Bullet }; Glib::ustring gtr_get_unicode_string(GtrUnicode uni); /* return a human-readable string for the size given in bytes. */ Glib::ustring tr_strlsize(guint64 size_in_bytes); Glib::ustring tr_strlsize(libtransmission::Values::Storage const& storage); /* return a human-readable string for the given ratio. */ Glib::ustring tr_strlratio(double ratio); std::string tr_format_time_relative(time_t timestamp, time_t origin); std::string tr_format_time_left(time_t timestamp); std::string tr_format_time(time_t timestamp); /*** **** ***/ using TrObjectSignalNotifyCallback = void(Glib::RefPtr const&); Glib::SignalProxy gtr_object_signal_notify(Glib::ObjectBase& object); void gtr_object_notify_emit(Glib::ObjectBase& object); template inline GParamSpec* gtr_get_param_spec(char const* name, char const* nick, char const* blurb) { auto dummy_value = Glib::Value(); dummy_value.init(decltype(dummy_value)::value_type()); return dummy_value.create_param_spec(name, nick, blurb, TR_GLIB_PARAM_FLAGS(READABLE)); } void gtr_open_uri(Glib::ustring const& uri); void gtr_open_file(std::string const& path); Glib::ustring gtr_get_help_uri(); /*** **** ***/ /* backwards-compatible wrapper around gtk_widget_set_visible() */ void gtr_widget_set_visible(Gtk::Widget& widget, bool is_visible); Gtk::Window& gtr_widget_get_window(Gtk::Widget& widget); void gtr_window_set_skip_taskbar_hint(Gtk::Window& window, bool value); void gtr_window_set_urgency_hint(Gtk::Window& window, bool value); void gtr_window_raise(Gtk::Window& window); /*** **** ***/ void gtr_priority_combo_init(Gtk::ComboBox& combo); void gtr_combo_box_set_enum(Gtk::ComboBox& combo, std::vector> const& items); int gtr_combo_box_get_active_enum(Gtk::ComboBox const& combo); void gtr_combo_box_set_active_enum(Gtk::ComboBox& combo, int value); /*** **** ***/ void gtr_unrecognized_url_dialog(Gtk::Widget& parent, Glib::ustring const& url); void gtr_add_torrent_error_dialog(Gtk::Widget& window_or_child, tr_torrent* duplicate_torrent, std::string const& filename); /* pop up the context menu if a user right-clicks. if the row they right-click on isn't selected, select it. */ bool on_item_view_button_pressed( Gtk::TreeView& view, double event_x, double event_y, bool context_menu_requested, std::function const& callback = {}); #if GTKMM_CHECK_VERSION(4, 0, 0) bool on_item_view_button_pressed( Gtk::ListView& view, double event_x, double event_y, bool context_menu_requested, std::function const& callback = {}); #endif /* if the click didn't specify a row, clear the selection */ bool on_item_view_button_released(Gtk::TreeView& view, double event_x, double event_y); #if GTKMM_CHECK_VERSION(4, 0, 0) bool on_item_view_button_released(Gtk::ListView& view, double event_x, double event_y); #endif using TrGdkModifierType = IF_GTKMM4(Gdk::ModifierType, guint); void setup_item_view_button_event_handling( Gtk::TreeView& view, std::function const& press_callback, std::function const& release_callback); #if GTKMM_CHECK_VERSION(4, 0, 0) void setup_item_view_button_event_handling( Gtk::ListView& view, std::function const& press_callback, std::function const& release_callback); #endif /* move a file to the trashcan if GIO is available; otherwise, delete it */ bool gtr_file_trash_or_remove(std::string const& filename, tr_error* error = nullptr); void gtr_paste_clipboard_url_into_entry(Gtk::Entry& entry); /* Only call gtk_label_set_text() if the new text differs from the old. * This prevents the label from having to recalculate its size * and prevents selected text in the label from being deselected */ void gtr_label_set_text(Gtk::Label& lb, Glib::ustring const& text); template inline T gtr_str_strip(T const& text) { auto const new_begin = text.find_first_not_of("\t\n\v\f\r "); auto const new_end = text.find_last_not_of("\t\n\v\f\r "); return new_begin == T::npos ? T() : text.substr(new_begin, new_end == T::npos ? new_end : new_end - new_begin + 1); } std::string gtr_get_full_resource_path(std::string const& rel_path); /*** **** ***/ class Session; extern size_t const max_recent_dirs; std::list gtr_get_recent_dirs(std::string const& pref); void gtr_save_recent_dir(std::string const& pref, Glib::RefPtr const& core, std::string const& dir); template inline Glib::RefPtr gtr_ptr_static_cast(Glib::RefPtr const& ptr) { #if GLIBMM_CHECK_VERSION(2, 68, 0) return std::static_pointer_cast(ptr); #else return Glib::RefPtr::cast_static(ptr); #endif } template inline Glib::RefPtr gtr_ptr_dynamic_cast(Glib::RefPtr const& ptr) { #if GLIBMM_CHECK_VERSION(2, 68, 0) return std::dynamic_pointer_cast(ptr); #else return Glib::RefPtr::cast_dynamic(ptr); #endif } template<> struct std::hash { std::size_t operator()(Glib::ustring const& s) const { return std::hash()(s.raw()); } }; template<> struct fmt::formatter : formatter { template auto format(Glib::ustring const& ustr, FormatContext& ctx) const { return formatter::format(ustr.raw(), ctx); } }; template T* gtr_get_widget(Glib::RefPtr const& builder, Glib::ustring const& name) { #if GTKMM_CHECK_VERSION(4, 0, 0) return builder->get_widget(name); #else T* widget = nullptr; builder->get_widget(name, widget); return widget; #endif } template T* gtr_get_widget_derived(Glib::RefPtr const& builder, Glib::ustring const& name, ArgTs&&... args) { #if GTKMM_CHECK_VERSION(4, 0, 0) return Gtk::Builder::get_widget_derived(builder, name, std::forward(args)...); #else T* widget = nullptr; builder->get_widget_derived(name, widget, std::forward(args)...); return widget; #endif } template void gtr_window_on_close(Gtk::Window& widget, F&& callback) { auto bool_callback = [callback = std::forward(callback)]() mutable -> bool { if constexpr (std::is_same_v>) { callback(); return false; } else { return callback(); } }; #if GTKMM_CHECK_VERSION(4, 0, 0) widget.signal_close_request().connect(bool_callback, false); #else widget.signal_delete_event().connect(sigc::hide<0>(bool_callback), false); #endif }