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/basename.h"
40 #include "pbd/file_utils.h"
41 #include "pbd/stacktrace.h"
43 #include <gtkmm2ext/utils.h>
45 #include "ardour/filesystem_paths.h"
46 #include "ardour/search_paths.h"
48 #include "canvas/item.h"
49 #include "canvas/utils.h"
52 #include "public_editor.h"
56 #include "rgb_macros.h"
57 #include "gui_thread.h"
58 #include "ui_config.h"
59 #include "ardour_dialog.h"
60 #include "ardour_ui.h"
66 using Gtkmm2ext::Keyboard;
68 namespace ARDOUR_UI_UTILS {
69 sigc::signal<void> DPIReset;
72 #ifdef PLATFORM_WINDOWS
73 #define random() rand()
77 /** Add an element to a menu, settings its sensitivity.
78 * @param m Menu to add to.
79 * @param e Element to add.
80 * @param s true to make sensitive, false to make insensitive
83 ARDOUR_UI_UTILS::add_item_with_sensitivity (Menu_Helpers::MenuList& m, Menu_Helpers::MenuElem e, bool s)
87 m.back().set_sensitive (false);
93 ARDOUR_UI_UTILS::just_hide_it (GdkEventAny */*ev*/, Gtk::Window *win)
99 /* xpm2rgb copied from nixieclock, which bore the legend:
101 nixieclock - a nixie desktop timepiece
102 Copyright (C) 2000 Greg Ercolano, erco@3dsite.com
104 and was released under the GPL.
108 ARDOUR_UI_UTILS::xpm2rgb (const char** xpm, uint32_t& w, uint32_t& h)
110 static long vals[256], val;
111 uint32_t t, x, y, colors, cpp;
113 unsigned char *savergb, *rgb;
117 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
118 error << string_compose (_("bad XPM header %1"), xpm[0])
123 savergb = rgb = (unsigned char*) malloc (h * w * 3);
125 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
126 for (t = 0; t < colors; ++t) {
127 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
131 // COLORMAP -> RGB CONVERSION
132 // Get low 3 bytes from vals[]
136 for (y = h-1; y > 0; --y) {
138 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 3) {
139 val = vals[(int)*p++];
140 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
141 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
142 *(rgb+0) = val & 0xff; // 0:R
150 ARDOUR_UI_UTILS::xpm2rgba (const char** xpm, uint32_t& w, uint32_t& h)
152 static long vals[256], val;
153 uint32_t t, x, y, colors, cpp;
155 unsigned char *savergb, *rgb;
160 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
161 error << string_compose (_("bad XPM header %1"), xpm[0])
166 savergb = rgb = (unsigned char*) malloc (h * w * 4);
168 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
170 if (strstr (xpm[1], "None")) {
171 sscanf (xpm[1], "%c", &transparent);
178 for (; t < colors; ++t) {
179 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
183 // COLORMAP -> RGB CONVERSION
184 // Get low 3 bytes from vals[]
188 for (y = h-1; y > 0; --y) {
192 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 4) {
194 if (transparent && (*p++ == transparent)) {
202 *(rgb+3) = alpha; // 3: alpha
203 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
204 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
205 *(rgb+0) = val & 0xff; // 0:R
212 /** Returns a Pango::FontDescription given a string describing the font.
214 * If the returned FontDescription does not specify a family, then
215 * the family is set to "Sans". This mirrors GTK's behaviour in
218 * Some environments will force Pango to specify the family
219 * even if it was not specified in the string describing the font.
220 * Such environments should be left unaffected by this function,
221 * since the font family will be left alone.
223 * There may be other similar font specification enforcement
224 * that we might add here later.
226 Pango::FontDescription
227 ARDOUR_UI_UTILS::sanitized_font (std::string const& name)
229 Pango::FontDescription fd (name);
231 if (fd.get_family().empty()) {
232 fd.set_family ("Sans");
238 Pango::FontDescription
239 ARDOUR_UI_UTILS::get_font_for_style (string widgetname)
241 Gtk::Window window (WINDOW_TOPLEVEL);
243 Glib::RefPtr<Gtk::Style> style;
246 foobar.set_name (widgetname);
247 foobar.ensure_style();
249 style = foobar.get_style ();
251 Glib::RefPtr<const Pango::Layout> layout = foobar.get_layout();
253 PangoFontDescription *pfd = const_cast<PangoFontDescription *> (pango_layout_get_font_description(const_cast<PangoLayout *>(layout->gobj())));
257 /* layout inherited its font description from a PangoContext */
259 PangoContext* ctxt = (PangoContext*) pango_layout_get_context (const_cast<PangoLayout*>(layout->gobj()));
260 pfd = pango_context_get_font_description (ctxt);
261 return Pango::FontDescription (pfd); /* make a copy */
264 return Pango::FontDescription (pfd); /* make a copy */
268 ARDOUR_UI_UTILS::set_color_from_rgb (Gdk::Color& c, uint32_t rgb)
270 /* Gdk::Color color ranges are 16 bit, so scale from 8 bit by
273 c.set_rgb ((rgb >> 16)*256, ((rgb & 0xff00) >> 8)*256, (rgb & 0xff)*256);
277 ARDOUR_UI_UTILS::set_color_from_rgba (Gdk::Color& c, uint32_t rgba)
279 /* Gdk::Color color ranges are 16 bit, so scale from 8 bit by
282 c.set_rgb ((rgba >> 24)*256, ((rgba & 0xff0000) >> 16)*256, ((rgba & 0xff00) >> 8)*256);
286 ARDOUR_UI_UTILS::gdk_color_to_rgba (Gdk::Color const& c)
288 /* since alpha value is not available from a Gdk::Color, it is
289 hardcoded as 0xff (aka 255 or 1.0)
292 const uint32_t r = c.get_red_p () * 255.0;
293 const uint32_t g = c.get_green_p () * 255.0;
294 const uint32_t b = c.get_blue_p () * 255.0;
295 const uint32_t a = 0xff;
297 return RGBA_TO_UINT (r,g,b,a);
302 ARDOUR_UI_UTILS::relay_key_press (GdkEventKey* ev, Gtk::Window* win)
304 return ARDOUR_UI::instance()->key_event_handler (ev, win);
308 ARDOUR_UI_UTILS::emulate_key_event (unsigned int keyval)
310 GdkDisplay *display = gtk_widget_get_display (GTK_WIDGET(ARDOUR_UI::instance()->main_window().gobj()));
311 GdkKeymap *keymap = gdk_keymap_get_for_display (display);
312 GdkKeymapKey *keymapkey = NULL;
315 if (!gdk_keymap_get_entries_for_keyval(keymap, keyval, &keymapkey, &n_keys)) return false;
316 if (n_keys !=1) { g_free(keymapkey); return false;}
318 Gtk::Window& main_window (ARDOUR_UI::instance()->main_window());
321 ev.type = GDK_KEY_PRESS;
322 ev.window = main_window.get_window()->gobj();
323 ev.send_event = FALSE;
328 ev.string = const_cast<gchar*> ("");
329 ev.hardware_keycode = keymapkey[0].keycode;
330 ev.group = keymapkey[0].group;
333 relay_key_press (&ev, &main_window);
334 ev.type = GDK_KEY_RELEASE;
335 return relay_key_press(&ev, &main_window);
339 ARDOUR_UI_UTILS::show_gdk_event_state (int state)
342 if (state & GDK_SHIFT_MASK) {
345 if (state & GDK_LOCK_MASK) {
348 if (state & GDK_CONTROL_MASK) {
351 if (state & GDK_MOD1_MASK) {
354 if (state & GDK_MOD2_MASK) {
357 if (state & GDK_MOD3_MASK) {
360 if (state & GDK_MOD4_MASK) {
363 if (state & GDK_MOD5_MASK) {
366 if (state & GDK_BUTTON1_MASK) {
369 if (state & GDK_BUTTON2_MASK) {
372 if (state & GDK_BUTTON3_MASK) {
375 if (state & GDK_BUTTON4_MASK) {
378 if (state & GDK_BUTTON5_MASK) {
381 if (state & GDK_SUPER_MASK) {
384 if (state & GDK_HYPER_MASK) {
387 if (state & GDK_META_MASK) {
390 if (state & GDK_RELEASE_MASK) {
397 Glib::RefPtr<Gdk::Pixbuf>
398 ARDOUR_UI_UTILS::get_xpm (std::string name)
400 if (!xpm_map[name]) {
402 Searchpath spath(ARDOUR::ardour_data_search_path());
404 spath.add_subdirectory_to_paths("pixmaps");
406 std::string data_file_path;
408 if(!find_file (spath, name, data_file_path)) {
409 fatal << string_compose (_("cannot find XPM file for %1"), name) << endmsg;
413 xpm_map[name] = Gdk::Pixbuf::create_from_file (data_file_path);
414 } catch(const Glib::Error& e) {
415 warning << "Caught Glib::Error: " << e.what() << endmsg;
419 return xpm_map[name];
423 ARDOUR_UI_UTILS::get_color_themes (map<std::string,std::string>& themes)
425 Searchpath spath(ARDOUR::theme_search_path());
427 for (vector<string>::iterator s = spath.begin(); s != spath.end(); ++s) {
429 vector<string> entries;
431 find_files_matching_pattern (entries, *s, string ("*") + UIConfiguration::color_file_suffix);
433 for (vector<string>::iterator e = entries.begin(); e != entries.end(); ++e) {
437 tree.read ((*e).c_str());
438 XMLNode* root = tree.root();
440 if (!root || root->name() != X_("Ardour")) {
444 XMLProperty const* prop = root->property (X_("theme-name"));
450 themes.insert (make_pair (prop->value(), Glib::filename_to_utf8 (basename_nosuffix(*e))));
456 ARDOUR_UI_UTILS::get_icon_sets ()
458 Searchpath spath(ARDOUR::ardour_data_search_path());
459 spath.add_subdirectory_to_paths ("icons");
462 r.push_back (_("default"));
464 for (vector<string>::iterator s = spath.begin(); s != spath.end(); ++s) {
466 vector<string> entries;
468 get_paths (entries, *s, false, false);
470 for (vector<string>::iterator e = entries.begin(); e != entries.end(); ++e) {
471 if (Glib::file_test (*e, Glib::FILE_TEST_IS_DIR)) {
472 r.push_back (Glib::filename_to_utf8 (Glib::path_get_basename(*e)));
481 ARDOUR_UI_UTILS::get_icon_path (const char* cname, string icon_set, bool is_image)
483 std::string data_file_path;
490 Searchpath spath(ARDOUR::ardour_data_search_path());
492 if (!icon_set.empty() && icon_set != _("default")) {
494 /* add "icons/icon_set" but .. not allowed to add both of these at once */
495 spath.add_subdirectory_to_paths ("icons");
496 spath.add_subdirectory_to_paths (icon_set);
498 find_file (spath, name, data_file_path);
500 spath.add_subdirectory_to_paths ("icons");
501 find_file (spath, name, data_file_path);
504 if (data_file_path.empty()) {
505 Searchpath rc (ARDOUR::ardour_data_search_path());
506 rc.add_subdirectory_to_paths ("resources");
507 find_file (rc, name, data_file_path);
510 if (is_image && data_file_path.empty()) {
512 if (!icon_set.empty() && icon_set != _("default")) {
513 warning << string_compose (_("icon \"%1\" not found for icon set \"%2\", fallback to default"), cname, icon_set) << endmsg;
516 Searchpath def (ARDOUR::ardour_data_search_path());
517 def.add_subdirectory_to_paths ("icons");
519 if (!find_file (def, name, data_file_path)) {
520 fatal << string_compose (_("cannot find icon image for %1 using %2"), name, spath.to_string()) << endmsg;
521 abort(); /*NOTREACHED*/
525 return data_file_path;
528 Glib::RefPtr<Gdk::Pixbuf>
529 ARDOUR_UI_UTILS::get_icon (const char* cname, string icon_set)
531 Glib::RefPtr<Gdk::Pixbuf> img;
533 img = Gdk::Pixbuf::create_from_file (get_icon_path (cname, icon_set));
534 } catch (const Gdk::PixbufError &e) {
535 cerr << "Caught PixbufError: " << e.what() << endl;
537 error << string_compose (_("Caught exception while loading icon named %1"), cname) << endmsg;
543 namespace ARDOUR_UI_UTILS {
544 Glib::RefPtr<Gdk::Pixbuf>
545 get_icon (const char* cname)
547 Glib::RefPtr<Gdk::Pixbuf> img;
549 img = Gdk::Pixbuf::create_from_file (get_icon_path (cname));
550 } catch (const Gdk::PixbufError &e) {
551 cerr << "Caught PixbufError: " << e.what() << endl;
553 error << string_compose (_("Caught exception while loading icon named %1"), cname) << endmsg;
561 ARDOUR_UI_UTILS::longest (vector<string>& strings)
563 if (strings.empty()) {
567 vector<string>::iterator longest = strings.begin();
568 string::size_type longest_length = (*longest).length();
570 vector<string>::iterator i = longest;
573 while (i != strings.end()) {
575 string::size_type len = (*i).length();
577 if (len > longest_length) {
579 longest_length = len;
589 ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (guint keyval)
591 /* we assume that this does not change over the life of the process
594 static int comma_decimal = -1;
599 if (comma_decimal < 0) {
600 std::lconv* lc = std::localeconv();
601 if (strchr (lc->decimal_point, ',') != 0) {
613 case GDK_decimalpoint:
614 case GDK_KP_Separator:
644 case GDK_KP_Subtract:
674 ARDOUR_UI_UTILS::resize_window_to_proportion_of_monitor (Gtk::Window* window, int max_width, int max_height)
676 Glib::RefPtr<Gdk::Screen> screen = window->get_screen ();
677 Gdk::Rectangle monitor_rect;
678 screen->get_monitor_geometry (0, monitor_rect);
680 int const w = std::min (int (monitor_rect.get_width() * 0.8), max_width);
681 int const h = std::min (int (monitor_rect.get_height() * 0.8), max_height);
683 window->resize (w, h);
687 /** Replace _ with __ in a string; for use with menu item text to make underscores displayed correctly */
689 ARDOUR_UI_UTILS::escape_underscores (string const & s)
692 string::size_type const N = s.length ();
694 for (string::size_type i = 0; i < N; ++i) {
706 ARDOUR_UI_UTILS::unique_random_color (list<Gdk::Color>& used_colors)
714 h = fmod (random(), 360.0);
715 s = (random() % 65535) / 65535.0;
716 v = (random() % 65535) / 65535.0;
718 s = min (0.5, s); /* not too saturated */
719 v = max (0.9, v); /* not too bright */
720 newcolor.set_hsv (h, s, v);
722 if (used_colors.size() == 0) {
723 used_colors.push_back (newcolor);
727 for (list<Gdk::Color>::iterator i = used_colors.begin(); i != used_colors.end(); ++i) {
729 float rdelta, bdelta, gdelta;
731 rdelta = newcolor.get_red() - c.get_red();
732 bdelta = newcolor.get_blue() - c.get_blue();
733 gdelta = newcolor.get_green() - c.get_green();
735 if (sqrt (rdelta*rdelta + bdelta*bdelta + gdelta*gdelta) > 25.0) {
736 /* different enough */
737 used_colors.push_back (newcolor);
742 /* XXX need throttle here to make sure we don't spin for ever */
747 ARDOUR_UI_UTILS::rate_as_string (float r)
750 if (fmod (r, 1000.0f)) {
751 snprintf (buf, sizeof (buf), "%.1f kHz", r/1000.0);
753 snprintf (buf, sizeof (buf), "%.0f kHz", r/1000.0);
759 ARDOUR_UI_UTILS::windows_overlap (Gtk::Window *a, Gtk::Window *b)
765 if (a->get_screen() == b->get_screen()) {
769 a->get_position (ex, ey);
770 a->get_size (ew, eh);
771 b->get_position (mx, my);
772 b->get_size (mw, mh);
788 if (gdk_rectangle_intersect (&e, &m, &r)) {
796 ARDOUR_UI_UTILS::overwrite_file_dialog (Gtk::Window& parent, string title, string text)
798 ArdourDialog dialog (parent, title, true);
801 dialog.get_vbox()->pack_start (label, true, true);
802 dialog.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
803 dialog.add_button (_("Overwrite"), Gtk::RESPONSE_ACCEPT);
806 switch (dialog.run()) {
807 case RESPONSE_ACCEPT:
809 case RESPONSE_CANCEL: