2 Copyright (C) 2003 Paul Davis
4 This program is free software; you an redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "gtk2ardour-config.h"
32 #include <gtkmm/window.h>
33 #include <gtkmm/combo.h>
34 #include <gtkmm/label.h>
35 #include <gtkmm/paned.h>
36 #include <gtk/gtkpaned.h>
37 #include <boost/algorithm/string.hpp>
39 #include "pbd/file_utils.h"
41 #include <gtkmm2ext/utils.h>
43 #include "ardour/filesystem_paths.h"
45 #include "canvas/item.h"
46 #include "canvas/utils.h"
49 #include "public_editor.h"
53 #include "rgb_macros.h"
54 #include "gui_thread.h"
55 #include "ui_config.h"
56 #include "ardour_dialog.h"
57 #include "ardour_ui.h"
63 using Gtkmm2ext::Keyboard;
65 namespace ARDOUR_UI_UTILS {
66 sigc::signal<void> DPIReset;
69 #ifdef PLATFORM_WINDOWS
70 #define random() rand()
74 /** Add an element to a menu, settings its sensitivity.
75 * @param m Menu to add to.
76 * @param e Element to add.
77 * @param s true to make sensitive, false to make insensitive
80 ARDOUR_UI_UTILS::add_item_with_sensitivity (Menu_Helpers::MenuList& m, Menu_Helpers::MenuElem e, bool s)
84 m.back().set_sensitive (false);
90 ARDOUR_UI_UTILS::just_hide_it (GdkEventAny */*ev*/, Gtk::Window *win)
96 /* xpm2rgb copied from nixieclock, which bore the legend:
98 nixieclock - a nixie desktop timepiece
99 Copyright (C) 2000 Greg Ercolano, erco@3dsite.com
101 and was released under the GPL.
105 ARDOUR_UI_UTILS::xpm2rgb (const char** xpm, uint32_t& w, uint32_t& h)
107 static long vals[256], val;
108 uint32_t t, x, y, colors, cpp;
110 unsigned char *savergb, *rgb;
114 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
115 error << string_compose (_("bad XPM header %1"), xpm[0])
120 savergb = rgb = (unsigned char*) malloc (h * w * 3);
122 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
123 for (t = 0; t < colors; ++t) {
124 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
128 // COLORMAP -> RGB CONVERSION
129 // Get low 3 bytes from vals[]
133 for (y = h-1; y > 0; --y) {
135 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 3) {
136 val = vals[(int)*p++];
137 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
138 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
139 *(rgb+0) = val & 0xff; // 0:R
147 ARDOUR_UI_UTILS::xpm2rgba (const char** xpm, uint32_t& w, uint32_t& h)
149 static long vals[256], val;
150 uint32_t t, x, y, colors, cpp;
152 unsigned char *savergb, *rgb;
157 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
158 error << string_compose (_("bad XPM header %1"), xpm[0])
163 savergb = rgb = (unsigned char*) malloc (h * w * 4);
165 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
167 if (strstr (xpm[1], "None")) {
168 sscanf (xpm[1], "%c", &transparent);
175 for (; t < colors; ++t) {
176 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
180 // COLORMAP -> RGB CONVERSION
181 // Get low 3 bytes from vals[]
185 for (y = h-1; y > 0; --y) {
189 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 4) {
191 if (transparent && (*p++ == transparent)) {
199 *(rgb+3) = alpha; // 3: alpha
200 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
201 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
202 *(rgb+0) = val & 0xff; // 0:R
209 /** Returns a Pango::FontDescription given a string describing the font.
211 * If the returned FontDescription does not specify a family, then
212 * the family is set to "Sans". This mirrors GTK's behaviour in
215 * Some environments will force Pango to specify the family
216 * even if it was not specified in the string describing the font.
217 * Such environments should be left unaffected by this function,
218 * since the font family will be left alone.
220 * There may be other similar font specification enforcement
221 * that we might add here later.
223 Pango::FontDescription
224 ARDOUR_UI_UTILS::sanitized_font (std::string const& name)
226 Pango::FontDescription fd (name);
228 if (fd.get_family().empty()) {
229 fd.set_family ("Sans");
235 Pango::FontDescription
236 ARDOUR_UI_UTILS::get_font_for_style (string widgetname)
238 Gtk::Window window (WINDOW_TOPLEVEL);
240 Glib::RefPtr<Gtk::Style> style;
243 foobar.set_name (widgetname);
244 foobar.ensure_style();
246 style = foobar.get_style ();
248 Glib::RefPtr<const Pango::Layout> layout = foobar.get_layout();
250 PangoFontDescription *pfd = const_cast<PangoFontDescription *> (pango_layout_get_font_description(const_cast<PangoLayout *>(layout->gobj())));
254 /* layout inherited its font description from a PangoContext */
256 PangoContext* ctxt = (PangoContext*) pango_layout_get_context (const_cast<PangoLayout*>(layout->gobj()));
257 pfd = pango_context_get_font_description (ctxt);
258 return Pango::FontDescription (pfd); /* make a copy */
261 return Pango::FontDescription (pfd); /* make a copy */
265 ARDOUR_UI_UTILS::set_color_from_rgb (Gdk::Color& c, uint32_t rgb)
267 /* Gdk::Color color ranges are 16 bit, so scale from 8 bit by
270 c.set_rgb ((rgb >> 16)*256, ((rgb & 0xff00) >> 8)*256, (rgb & 0xff)*256);
274 ARDOUR_UI_UTILS::set_color_from_rgba (Gdk::Color& c, uint32_t rgba)
276 /* Gdk::Color color ranges are 16 bit, so scale from 8 bit by
279 c.set_rgb ((rgba >> 24)*256, ((rgba & 0xff0000) >> 16)*256, ((rgba & 0xff00) >> 8)*256);
283 ARDOUR_UI_UTILS::gdk_color_to_rgba (Gdk::Color const& c)
285 /* since alpha value is not available from a Gdk::Color, it is
286 hardcoded as 0xff (aka 255 or 1.0)
289 const uint32_t r = c.get_red_p () * 255.0;
290 const uint32_t g = c.get_green_p () * 255.0;
291 const uint32_t b = c.get_blue_p () * 255.0;
292 const uint32_t a = 0xff;
294 return RGBA_TO_UINT (r,g,b,a);
299 ARDOUR_UI_UTILS::relay_key_press (GdkEventKey* ev, Gtk::Window* win)
301 return ARDOUR_UI::instance()->key_event_handler (ev, win);
305 ARDOUR_UI_UTILS::emulate_key_event (unsigned int keyval)
307 GdkDisplay *display = gtk_widget_get_display (GTK_WIDGET(ARDOUR_UI::instance()->main_window().gobj()));
308 GdkKeymap *keymap = gdk_keymap_get_for_display (display);
309 GdkKeymapKey *keymapkey = NULL;
312 if (!gdk_keymap_get_entries_for_keyval(keymap, keyval, &keymapkey, &n_keys)) return false;
313 if (n_keys !=1) { g_free(keymapkey); return false;}
315 Gtk::Window& main_window (ARDOUR_UI::instance()->main_window());
318 ev.type = GDK_KEY_PRESS;
319 ev.window = main_window.get_window()->gobj();
320 ev.send_event = FALSE;
325 ev.string = const_cast<gchar*> ("");
326 ev.hardware_keycode = keymapkey[0].keycode;
327 ev.group = keymapkey[0].group;
330 relay_key_press (&ev, &main_window);
331 ev.type = GDK_KEY_RELEASE;
332 return relay_key_press(&ev, &main_window);
336 ARDOUR_UI_UTILS::show_gdk_event_state (int state)
339 if (state & GDK_SHIFT_MASK) {
342 if (state & GDK_LOCK_MASK) {
345 if (state & GDK_CONTROL_MASK) {
348 if (state & GDK_MOD1_MASK) {
351 if (state & GDK_MOD2_MASK) {
354 if (state & GDK_MOD3_MASK) {
357 if (state & GDK_MOD4_MASK) {
360 if (state & GDK_MOD5_MASK) {
363 if (state & GDK_BUTTON1_MASK) {
366 if (state & GDK_BUTTON2_MASK) {
369 if (state & GDK_BUTTON3_MASK) {
372 if (state & GDK_BUTTON4_MASK) {
375 if (state & GDK_BUTTON5_MASK) {
378 if (state & GDK_SUPER_MASK) {
381 if (state & GDK_HYPER_MASK) {
384 if (state & GDK_META_MASK) {
387 if (state & GDK_RELEASE_MASK) {
394 Glib::RefPtr<Gdk::Pixbuf>
395 ARDOUR_UI_UTILS::get_xpm (std::string name)
397 if (!xpm_map[name]) {
399 Searchpath spath(ARDOUR::ardour_data_search_path());
401 spath.add_subdirectory_to_paths("pixmaps");
403 std::string data_file_path;
405 if(!find_file (spath, name, data_file_path)) {
406 fatal << string_compose (_("cannot find XPM file for %1"), name) << endmsg;
410 xpm_map[name] = Gdk::Pixbuf::create_from_file (data_file_path);
411 } catch(const Glib::Error& e) {
412 warning << "Caught Glib::Error: " << e.what() << endmsg;
416 return xpm_map[name];
420 ARDOUR_UI_UTILS::get_icon_sets ()
422 Searchpath spath(ARDOUR::ardour_data_search_path());
423 spath.add_subdirectory_to_paths ("icons");
426 r.push_back (_("default"));
428 for (vector<string>::iterator s = spath.begin(); s != spath.end(); ++s) {
430 vector<string> entries;
432 get_paths (entries, *s, false, false);
434 for (vector<string>::iterator e = entries.begin(); e != entries.end(); ++e) {
435 if (Glib::file_test (*e, Glib::FILE_TEST_IS_DIR)) {
436 r.push_back (Glib::filename_to_utf8 (Glib::path_get_basename(*e)));
445 ARDOUR_UI_UTILS::get_icon_path (const char* cname, string icon_set, bool is_image)
447 std::string data_file_path;
454 Searchpath spath(ARDOUR::ardour_data_search_path());
456 if (!icon_set.empty() && icon_set != _("default")) {
458 /* add "icons/icon_set" but .. not allowed to add both of these at once */
459 spath.add_subdirectory_to_paths ("icons");
460 spath.add_subdirectory_to_paths (icon_set);
462 find_file (spath, name, data_file_path);
464 spath.add_subdirectory_to_paths ("icons");
465 find_file (spath, name, data_file_path);
468 if (data_file_path.empty()) {
469 Searchpath rc (ARDOUR::ardour_data_search_path());
470 rc.add_subdirectory_to_paths ("resources");
471 find_file (rc, name, data_file_path);
474 if (is_image && data_file_path.empty()) {
476 if (!icon_set.empty() && icon_set != _("default")) {
477 warning << string_compose (_("icon \"%1\" not found for icon set \"%2\", fallback to default"), cname, icon_set) << endmsg;
480 Searchpath def (ARDOUR::ardour_data_search_path());
481 def.add_subdirectory_to_paths ("icons");
483 if (!find_file (def, name, data_file_path)) {
484 fatal << string_compose (_("cannot find icon image for %1 using %2"), name, spath.to_string()) << endmsg;
485 abort(); /*NOTREACHED*/
489 return data_file_path;
492 Glib::RefPtr<Gdk::Pixbuf>
493 ARDOUR_UI_UTILS::get_icon (const char* cname, string icon_set)
495 Glib::RefPtr<Gdk::Pixbuf> img;
497 img = Gdk::Pixbuf::create_from_file (get_icon_path (cname, icon_set));
498 } catch (const Gdk::PixbufError &e) {
499 cerr << "Caught PixbufError: " << e.what() << endl;
501 error << string_compose (_("Caught exception while loading icon named %1"), cname) << endmsg;
507 namespace ARDOUR_UI_UTILS {
508 Glib::RefPtr<Gdk::Pixbuf>
509 get_icon (const char* cname)
511 Glib::RefPtr<Gdk::Pixbuf> img;
513 img = Gdk::Pixbuf::create_from_file (get_icon_path (cname));
514 } catch (const Gdk::PixbufError &e) {
515 cerr << "Caught PixbufError: " << e.what() << endl;
517 error << string_compose (_("Caught exception while loading icon named %1"), cname) << endmsg;
525 ARDOUR_UI_UTILS::longest (vector<string>& strings)
527 if (strings.empty()) {
531 vector<string>::iterator longest = strings.begin();
532 string::size_type longest_length = (*longest).length();
534 vector<string>::iterator i = longest;
537 while (i != strings.end()) {
539 string::size_type len = (*i).length();
541 if (len > longest_length) {
543 longest_length = len;
553 ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (guint keyval)
555 /* we assume that this does not change over the life of the process
558 static int comma_decimal = -1;
563 if (comma_decimal < 0) {
564 std::lconv* lc = std::localeconv();
565 if (strchr (lc->decimal_point, ',') != 0) {
577 case GDK_decimalpoint:
578 case GDK_KP_Separator:
608 case GDK_KP_Subtract:
638 ARDOUR_UI_UTILS::resize_window_to_proportion_of_monitor (Gtk::Window* window, int max_width, int max_height)
640 Glib::RefPtr<Gdk::Screen> screen = window->get_screen ();
641 Gdk::Rectangle monitor_rect;
642 screen->get_monitor_geometry (0, monitor_rect);
644 int const w = std::min (int (monitor_rect.get_width() * 0.8), max_width);
645 int const h = std::min (int (monitor_rect.get_height() * 0.8), max_height);
647 window->resize (w, h);
651 /** Replace _ with __ in a string; for use with menu item text to make underscores displayed correctly */
653 ARDOUR_UI_UTILS::escape_underscores (string const & s)
656 string::size_type const N = s.length ();
658 for (string::size_type i = 0; i < N; ++i) {
669 /** Replace < and > with < and > respectively to make < > display correctly in markup strings */
671 ARDOUR_UI_UTILS::escape_angled_brackets (string const & s)
674 boost::replace_all (o, "<", "<");
675 boost::replace_all (o, ">", ">");
680 ARDOUR_UI_UTILS::unique_random_color (list<Gdk::Color>& used_colors)
688 h = fmod (random(), 360.0);
689 s = (random() % 65535) / 65535.0;
690 v = (random() % 65535) / 65535.0;
692 s = min (0.5, s); /* not too saturated */
693 v = max (0.9, v); /* not too bright */
694 newcolor.set_hsv (h, s, v);
696 if (used_colors.size() == 0) {
697 used_colors.push_back (newcolor);
701 for (list<Gdk::Color>::iterator i = used_colors.begin(); i != used_colors.end(); ++i) {
703 float rdelta, bdelta, gdelta;
705 rdelta = newcolor.get_red() - c.get_red();
706 bdelta = newcolor.get_blue() - c.get_blue();
707 gdelta = newcolor.get_green() - c.get_green();
709 if (sqrt (rdelta*rdelta + bdelta*bdelta + gdelta*gdelta) > 25.0) {
710 /* different enough */
711 used_colors.push_back (newcolor);
716 /* XXX need throttle here to make sure we don't spin for ever */
721 ARDOUR_UI_UTILS::rate_as_string (float r)
724 if (fmod (r, 1000.0f)) {
725 snprintf (buf, sizeof (buf), "%.1f kHz", r/1000.0);
727 snprintf (buf, sizeof (buf), "%.0f kHz", r/1000.0);
733 ARDOUR_UI_UTILS::windows_overlap (Gtk::Window *a, Gtk::Window *b)
739 if (a->get_screen() == b->get_screen()) {
743 a->get_position (ex, ey);
744 a->get_size (ew, eh);
745 b->get_position (mx, my);
746 b->get_size (mw, mh);
762 if (gdk_rectangle_intersect (&e, &m, &r)) {
770 ARDOUR_UI_UTILS::overwrite_file_dialog (Gtk::Window& parent, string title, string text)
772 ArdourDialog dialog (parent, title, true);
775 dialog.get_vbox()->pack_start (label, true, true);
776 dialog.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
777 dialog.add_button (_("Overwrite"), Gtk::RESPONSE_ACCEPT);
780 switch (dialog.run()) {
781 case RESPONSE_ACCEPT:
783 case RESPONSE_CANCEL: