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"
62 using Gtkmm2ext::Keyboard;
64 namespace ARDOUR_UI_UTILS {
65 sigc::signal<void> DPIReset;
68 #ifdef PLATFORM_WINDOWS
69 #define random() rand()
73 /** Add an element to a menu, settings its sensitivity.
74 * @param m Menu to add to.
75 * @param e Element to add.
76 * @param s true to make sensitive, false to make insensitive
79 ARDOUR_UI_UTILS::add_item_with_sensitivity (Menu_Helpers::MenuList& m, Menu_Helpers::MenuElem e, bool s)
83 m.back().set_sensitive (false);
89 ARDOUR_UI_UTILS::just_hide_it (GdkEventAny */*ev*/, Gtk::Window *win)
95 /* xpm2rgb copied from nixieclock, which bore the legend:
97 nixieclock - a nixie desktop timepiece
98 Copyright (C) 2000 Greg Ercolano, erco@3dsite.com
100 and was released under the GPL.
104 ARDOUR_UI_UTILS::xpm2rgb (const char** xpm, uint32_t& w, uint32_t& h)
106 static long vals[256], val;
107 uint32_t t, x, y, colors, cpp;
109 unsigned char *savergb, *rgb;
113 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
114 error << string_compose (_("bad XPM header %1"), xpm[0])
119 savergb = rgb = (unsigned char*) malloc (h * w * 3);
121 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
122 for (t = 0; t < colors; ++t) {
123 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
127 // COLORMAP -> RGB CONVERSION
128 // Get low 3 bytes from vals[]
132 for (y = h-1; y > 0; --y) {
134 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 3) {
135 val = vals[(int)*p++];
136 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
137 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
138 *(rgb+0) = val & 0xff; // 0:R
146 ARDOUR_UI_UTILS::xpm2rgba (const char** xpm, uint32_t& w, uint32_t& h)
148 static long vals[256], val;
149 uint32_t t, x, y, colors, cpp;
151 unsigned char *savergb, *rgb;
156 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
157 error << string_compose (_("bad XPM header %1"), xpm[0])
162 savergb = rgb = (unsigned char*) malloc (h * w * 4);
164 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
166 if (strstr (xpm[1], "None")) {
167 sscanf (xpm[1], "%c", &transparent);
174 for (; t < colors; ++t) {
175 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
179 // COLORMAP -> RGB CONVERSION
180 // Get low 3 bytes from vals[]
184 for (y = h-1; y > 0; --y) {
188 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 4) {
190 if (transparent && (*p++ == transparent)) {
198 *(rgb+3) = alpha; // 3: alpha
199 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
200 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
201 *(rgb+0) = val & 0xff; // 0:R
208 /** Returns a Pango::FontDescription given a string describing the font.
210 * If the returned FontDescription does not specify a family, then
211 * the family is set to "Sans". This mirrors GTK's behaviour in
214 * Some environments will force Pango to specify the family
215 * even if it was not specified in the string describing the font.
216 * Such environments should be left unaffected by this function,
217 * since the font family will be left alone.
219 * There may be other similar font specification enforcement
220 * that we might add here later.
222 Pango::FontDescription
223 ARDOUR_UI_UTILS::sanitized_font (std::string const& name)
225 Pango::FontDescription fd (name);
227 if (fd.get_family().empty()) {
228 fd.set_family ("Sans");
234 Pango::FontDescription
235 ARDOUR_UI_UTILS::get_font_for_style (string widgetname)
237 Gtk::Window window (WINDOW_TOPLEVEL);
239 Glib::RefPtr<Gtk::Style> style;
242 foobar.set_name (widgetname);
243 foobar.ensure_style();
245 style = foobar.get_style ();
247 Glib::RefPtr<const Pango::Layout> layout = foobar.get_layout();
249 PangoFontDescription *pfd = const_cast<PangoFontDescription *> (pango_layout_get_font_description(const_cast<PangoLayout *>(layout->gobj())));
253 /* layout inherited its font description from a PangoContext */
255 PangoContext* ctxt = (PangoContext*) pango_layout_get_context (const_cast<PangoLayout*>(layout->gobj()));
256 pfd = pango_context_get_font_description (ctxt);
257 return Pango::FontDescription (pfd); /* make a copy */
260 return Pango::FontDescription (pfd); /* make a copy */
264 ARDOUR_UI_UTILS::set_color_from_rgb (Gdk::Color& c, uint32_t rgb)
266 /* Gdk::Color color ranges are 16 bit, so scale from 8 bit by
269 c.set_rgb ((rgb >> 16)*256, ((rgb & 0xff00) >> 8)*256, (rgb & 0xff)*256);
273 ARDOUR_UI_UTILS::set_color_from_rgba (Gdk::Color& c, uint32_t rgba)
275 /* Gdk::Color color ranges are 16 bit, so scale from 8 bit by
278 c.set_rgb ((rgba >> 24)*256, ((rgba & 0xff0000) >> 16)*256, ((rgba & 0xff00) >> 8)*256);
282 ARDOUR_UI_UTILS::gdk_color_to_rgba (Gdk::Color const& c)
284 /* since alpha value is not available from a Gdk::Color, it is
285 hardcoded as 0xff (aka 255 or 1.0)
288 const uint32_t r = c.get_red_p () * 255.0;
289 const uint32_t g = c.get_green_p () * 255.0;
290 const uint32_t b = c.get_blue_p () * 255.0;
291 const uint32_t a = 0xff;
293 return RGBA_TO_UINT (r,g,b,a);
298 ARDOUR_UI_UTILS::relay_key_press (GdkEventKey* ev, Gtk::Window* win)
300 return ARDOUR_UI::instance()->key_event_handler (ev, win);
304 ARDOUR_UI_UTILS::emulate_key_event (unsigned int keyval)
306 GdkDisplay *display = gtk_widget_get_display (GTK_WIDGET(ARDOUR_UI::instance()->main_window().gobj()));
307 GdkKeymap *keymap = gdk_keymap_get_for_display (display);
308 GdkKeymapKey *keymapkey = NULL;
311 if (!gdk_keymap_get_entries_for_keyval(keymap, keyval, &keymapkey, &n_keys)) return false;
312 if (n_keys !=1) { g_free(keymapkey); return false;}
314 Gtk::Window& main_window (ARDOUR_UI::instance()->main_window());
317 ev.type = GDK_KEY_PRESS;
318 ev.window = main_window.get_window()->gobj();
319 ev.send_event = FALSE;
324 ev.string = const_cast<gchar*> ("");
325 ev.hardware_keycode = keymapkey[0].keycode;
326 ev.group = keymapkey[0].group;
329 relay_key_press (&ev, &main_window);
330 ev.type = GDK_KEY_RELEASE;
331 return relay_key_press(&ev, &main_window);
335 ARDOUR_UI_UTILS::show_gdk_event_state (int state)
338 if (state & GDK_SHIFT_MASK) {
341 if (state & GDK_LOCK_MASK) {
344 if (state & GDK_CONTROL_MASK) {
347 if (state & GDK_MOD1_MASK) {
350 if (state & GDK_MOD2_MASK) {
353 if (state & GDK_MOD3_MASK) {
356 if (state & GDK_MOD4_MASK) {
359 if (state & GDK_MOD5_MASK) {
362 if (state & GDK_BUTTON1_MASK) {
365 if (state & GDK_BUTTON2_MASK) {
368 if (state & GDK_BUTTON3_MASK) {
371 if (state & GDK_BUTTON4_MASK) {
374 if (state & GDK_BUTTON5_MASK) {
377 if (state & GDK_SUPER_MASK) {
380 if (state & GDK_HYPER_MASK) {
383 if (state & GDK_META_MASK) {
386 if (state & GDK_RELEASE_MASK) {
393 Glib::RefPtr<Gdk::Pixbuf>
394 ARDOUR_UI_UTILS::get_xpm (std::string name)
396 if (!xpm_map[name]) {
398 Searchpath spath(ARDOUR::ardour_data_search_path());
400 spath.add_subdirectory_to_paths("pixmaps");
402 std::string data_file_path;
404 if(!find_file (spath, name, data_file_path)) {
405 fatal << string_compose (_("cannot find XPM file for %1"), name) << endmsg;
409 xpm_map[name] = Gdk::Pixbuf::create_from_file (data_file_path);
410 } catch(const Glib::Error& e) {
411 warning << "Caught Glib::Error: " << e.what() << endmsg;
415 return xpm_map[name];
419 ARDOUR_UI_UTILS::get_icon_sets ()
421 Searchpath spath(ARDOUR::ardour_data_search_path());
422 spath.add_subdirectory_to_paths ("icons");
425 r.push_back (_("default"));
427 for (vector<string>::iterator s = spath.begin(); s != spath.end(); ++s) {
429 vector<string> entries;
431 get_paths (entries, *s, false, false);
433 for (vector<string>::iterator e = entries.begin(); e != entries.end(); ++e) {
434 if (Glib::file_test (*e, Glib::FILE_TEST_IS_DIR)) {
435 r.push_back (Glib::filename_to_utf8 (Glib::path_get_basename(*e)));
444 ARDOUR_UI_UTILS::get_icon_path (const char* cname, string icon_set, bool is_image)
446 std::string data_file_path;
453 Searchpath spath(ARDOUR::ardour_data_search_path());
455 if (!icon_set.empty() && icon_set != _("default")) {
457 /* add "icons/icon_set" but .. not allowed to add both of these at once */
458 spath.add_subdirectory_to_paths ("icons");
459 spath.add_subdirectory_to_paths (icon_set);
461 find_file (spath, name, data_file_path);
463 spath.add_subdirectory_to_paths ("icons");
464 find_file (spath, name, data_file_path);
467 if (is_image && data_file_path.empty()) {
469 if (!icon_set.empty() && icon_set != _("default")) {
470 warning << string_compose (_("icon \"%1\" not found for icon set \"%2\", fallback to default"), cname, icon_set) << endmsg;
473 Searchpath def (ARDOUR::ardour_data_search_path());
474 def.add_subdirectory_to_paths ("icons");
476 if (!find_file (def, name, data_file_path)) {
477 fatal << string_compose (_("cannot find icon image for %1 using %2"), name, spath.to_string()) << endmsg;
478 abort(); /*NOTREACHED*/
482 return data_file_path;
485 Glib::RefPtr<Gdk::Pixbuf>
486 ARDOUR_UI_UTILS::get_icon (const char* cname, string icon_set)
488 Glib::RefPtr<Gdk::Pixbuf> img;
490 img = Gdk::Pixbuf::create_from_file (get_icon_path (cname, icon_set));
491 } catch (const Gdk::PixbufError &e) {
492 cerr << "Caught PixbufError: " << e.what() << endl;
494 error << string_compose (_("Caught exception while loading icon named %1"), cname) << endmsg;
500 namespace ARDOUR_UI_UTILS {
501 Glib::RefPtr<Gdk::Pixbuf>
502 get_icon (const char* cname)
504 Glib::RefPtr<Gdk::Pixbuf> img;
506 img = Gdk::Pixbuf::create_from_file (get_icon_path (cname));
507 } catch (const Gdk::PixbufError &e) {
508 cerr << "Caught PixbufError: " << e.what() << endl;
510 error << string_compose (_("Caught exception while loading icon named %1"), cname) << endmsg;
518 ARDOUR_UI_UTILS::longest (vector<string>& strings)
520 if (strings.empty()) {
524 vector<string>::iterator longest = strings.begin();
525 string::size_type longest_length = (*longest).length();
527 vector<string>::iterator i = longest;
530 while (i != strings.end()) {
532 string::size_type len = (*i).length();
534 if (len > longest_length) {
536 longest_length = len;
546 ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (guint keyval)
548 /* we assume that this does not change over the life of the process
551 static int comma_decimal = -1;
556 if (comma_decimal < 0) {
557 std::lconv* lc = std::localeconv();
558 if (strchr (lc->decimal_point, ',') != 0) {
570 case GDK_decimalpoint:
571 case GDK_KP_Separator:
601 case GDK_KP_Subtract:
631 ARDOUR_UI_UTILS::resize_window_to_proportion_of_monitor (Gtk::Window* window, int max_width, int max_height)
633 Glib::RefPtr<Gdk::Screen> screen = window->get_screen ();
634 Gdk::Rectangle monitor_rect;
635 screen->get_monitor_geometry (0, monitor_rect);
637 int const w = std::min (int (monitor_rect.get_width() * 0.8), max_width);
638 int const h = std::min (int (monitor_rect.get_height() * 0.8), max_height);
640 window->resize (w, h);
644 /** Replace _ with __ in a string; for use with menu item text to make underscores displayed correctly */
646 ARDOUR_UI_UTILS::escape_underscores (string const & s)
649 string::size_type const N = s.length ();
651 for (string::size_type i = 0; i < N; ++i) {
662 /** Replace < and > with < and > respectively to make < > display correctly in markup strings */
664 ARDOUR_UI_UTILS::escape_angled_brackets (string const & s)
667 boost::replace_all (o, "<", "<");
668 boost::replace_all (o, ">", ">");
673 ARDOUR_UI_UTILS::unique_random_color (list<Gdk::Color>& used_colors)
681 h = fmod (random(), 360.0);
682 s = (random() % 65535) / 65535.0;
683 v = (random() % 65535) / 65535.0;
685 s = min (0.5, s); /* not too saturated */
686 v = max (0.9, v); /* not too bright */
687 newcolor.set_hsv (h, s, v);
689 if (used_colors.size() == 0) {
690 used_colors.push_back (newcolor);
694 for (list<Gdk::Color>::iterator i = used_colors.begin(); i != used_colors.end(); ++i) {
696 float rdelta, bdelta, gdelta;
698 rdelta = newcolor.get_red() - c.get_red();
699 bdelta = newcolor.get_blue() - c.get_blue();
700 gdelta = newcolor.get_green() - c.get_green();
702 if (sqrt (rdelta*rdelta + bdelta*bdelta + gdelta*gdelta) > 25.0) {
703 /* different enough */
704 used_colors.push_back (newcolor);
709 /* XXX need throttle here to make sure we don't spin for ever */
714 ARDOUR_UI_UTILS::rate_as_string (float r)
717 if (fmod (r, 1000.0f)) {
718 snprintf (buf, sizeof (buf), "%.1f kHz", r/1000.0);
720 snprintf (buf, sizeof (buf), "%.0f kHz", r/1000.0);
726 ARDOUR_UI_UTILS::windows_overlap (Gtk::Window *a, Gtk::Window *b)
732 if (a->get_screen() == b->get_screen()) {
736 a->get_position (ex, ey);
737 a->get_size (ew, eh);
738 b->get_position (mx, my);
739 b->get_size (mw, mh);
755 if (gdk_rectangle_intersect (&e, &m, &r)) {
763 ARDOUR_UI_UTILS::overwrite_file_dialog (Gtk::Window& parent, string title, string text)
765 ArdourDialog dialog (parent, title, true);
768 dialog.get_vbox()->pack_start (label, true, true);
769 dialog.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
770 dialog.add_button (_("Overwrite"), Gtk::RESPONSE_ACCEPT);
773 switch (dialog.run()) {
774 case RESPONSE_ACCEPT:
776 case RESPONSE_CANCEL: