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"
24 #include <pango/pangoft2.h> // for fontmap resolution control for GnomeCanvas
25 #include <pango/pangocairo.h> // for fontmap resolution control for GnomeCanvas
34 #include <libart_lgpl/art_misc.h>
36 #include <gtkmm/window.h>
37 #include <gtkmm/combo.h>
38 #include <gtkmm/label.h>
39 #include <gtkmm/paned.h>
40 #include <gtk/gtkpaned.h>
41 #include <boost/algorithm/string.hpp>
43 #include "pbd/file_utils.h"
45 #include <gtkmm2ext/utils.h>
46 #include "ardour/rc_configuration.h"
48 #include "ardour/filesystem_paths.h"
50 #include "ardour_ui.h"
52 #include "public_editor.h"
56 #include "rgb_macros.h"
57 #include "canvas_impl.h"
58 #include "gui_thread.h"
64 using Gtkmm2ext::Keyboard;
66 sigc::signal<void> DPIReset;
69 /** Add an element to a menu, settings its sensitivity.
70 * @param m Menu to add to.
71 * @param e Element to add.
72 * @param s true to make sensitive, false to make insensitive
75 add_item_with_sensitivity (Menu_Helpers::MenuList& m, Menu_Helpers::MenuElem e, bool s)
79 m.back().set_sensitive (false);
85 just_hide_it (GdkEventAny */*ev*/, Gtk::Window *win)
91 /* xpm2rgb copied from nixieclock, which bore the legend:
93 nixieclock - a nixie desktop timepiece
94 Copyright (C) 2000 Greg Ercolano, erco@3dsite.com
96 and was released under the GPL.
100 xpm2rgb (const char** xpm, uint32_t& w, uint32_t& h)
102 static long vals[256], val;
103 uint32_t t, x, y, colors, cpp;
105 unsigned char *savergb, *rgb;
109 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
110 error << string_compose (_("bad XPM header %1"), xpm[0])
115 savergb = rgb = (unsigned char*) malloc (h * w * 3);
117 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
118 for (t = 0; t < colors; ++t) {
119 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
123 // COLORMAP -> RGB CONVERSION
124 // Get low 3 bytes from vals[]
128 for (y = h-1; y > 0; --y) {
130 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 3) {
131 val = vals[(int)*p++];
132 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
133 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
134 *(rgb+0) = val & 0xff; // 0:R
142 xpm2rgba (const char** xpm, uint32_t& w, uint32_t& h)
144 static long vals[256], val;
145 uint32_t t, x, y, colors, cpp;
147 unsigned char *savergb, *rgb;
152 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
153 error << string_compose (_("bad XPM header %1"), xpm[0])
158 savergb = rgb = (unsigned char*) malloc (h * w * 4);
160 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
162 if (strstr (xpm[1], "None")) {
163 sscanf (xpm[1], "%c", &transparent);
170 for (; t < colors; ++t) {
171 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
175 // COLORMAP -> RGB CONVERSION
176 // Get low 3 bytes from vals[]
180 for (y = h-1; y > 0; --y) {
184 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 4) {
186 if (transparent && (*p++ == transparent)) {
194 *(rgb+3) = alpha; // 3: alpha
195 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
196 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
197 *(rgb+0) = val & 0xff; // 0:R
204 ArdourCanvas::Points*
205 get_canvas_points (string /*who*/, uint32_t npoints)
207 // cerr << who << ": wants " << npoints << " canvas points" << endl;
208 #ifdef TRAP_EXCESSIVE_POINT_REQUESTS
209 if (npoints > (uint32_t) gdk_screen_width() + 4) {
213 return new ArdourCanvas::Points (npoints);
216 Pango::FontDescription
217 get_font_for_style (string widgetname)
219 Gtk::Window window (WINDOW_TOPLEVEL);
221 Glib::RefPtr<Gtk::Style> style;
224 foobar.set_name (widgetname);
225 foobar.ensure_style();
227 style = foobar.get_style ();
229 Glib::RefPtr<const Pango::Layout> layout = foobar.get_layout();
231 PangoFontDescription *pfd = const_cast<PangoFontDescription *> (pango_layout_get_font_description(const_cast<PangoLayout *>(layout->gobj())));
235 /* layout inherited its font description from a PangoContext */
237 PangoContext* ctxt = (PangoContext*) pango_layout_get_context (const_cast<PangoLayout*>(layout->gobj()));
238 pfd = pango_context_get_font_description (ctxt);
239 return Pango::FontDescription (pfd); /* make a copy */
242 return Pango::FontDescription (pfd); /* make a copy */
246 rgba_from_style (string style, uint32_t r, uint32_t g, uint32_t b, uint32_t a, string attr, int state, bool rgba)
248 /* In GTK+2, styles aren't set up correctly if the widget is not
249 attached to a toplevel window that has a screen pointer.
252 static Gtk::Window* window = 0;
255 window = new Window (WINDOW_TOPLEVEL);
262 foo.set_name (style);
265 GtkRcStyle* rc = foo.get_style()->gobj()->rc_style;
269 r = rc->fg[state].red / 257;
270 g = rc->fg[state].green / 257;
271 b = rc->fg[state].blue / 257;
273 /* what a hack ... "a" is for "active" */
274 if (state == Gtk::STATE_NORMAL && rgba) {
275 a = rc->fg[GTK_STATE_ACTIVE].red / 257;
277 } else if (attr == "bg") {
279 r = rc->bg[state].red / 257;
280 g = rc->bg[state].green / 257;
281 b = rc->bg[state].blue / 257;
282 } else if (attr == "base") {
283 r = rc->base[state].red / 257;
284 g = rc->base[state].green / 257;
285 b = rc->base[state].blue / 257;
286 } else if (attr == "text") {
287 r = rc->text[state].red / 257;
288 g = rc->text[state].green / 257;
289 b = rc->text[state].blue / 257;
292 warning << string_compose (_("missing RGBA style for \"%1\""), style) << endl;
297 if (state == Gtk::STATE_NORMAL && rgba) {
298 return (uint32_t) RGBA_TO_UINT(r,g,b,a);
300 return (uint32_t) RGB_TO_UINT(r,g,b);
305 canvas_item_visible (ArdourCanvas::Item* item)
307 return (item->gobj()->object.flags & GNOME_CANVAS_ITEM_VISIBLE) ? true : false;
311 set_color (Gdk::Color& c, int rgb)
313 c.set_rgb((rgb >> 16)*256, ((rgb & 0xff00) >> 8)*256, (rgb & 0xff)*256);
317 relay_key_press (GdkEventKey* ev, Gtk::Window* win)
319 if (!key_press_focus_accelerator_handler (*win, ev)) {
320 return PublicEditor::instance().on_key_press_event(ev);
327 forward_key_press (GdkEventKey* ev)
329 return PublicEditor::instance().on_key_press_event(ev);
333 emulate_key_event (Gtk::Widget* w, unsigned int keyval)
335 GdkDisplay *display = gtk_widget_get_display (GTK_WIDGET(w->gobj()));
336 GdkKeymap *keymap = gdk_keymap_get_for_display (display);
337 GdkKeymapKey *keymapkey = NULL;
340 if (!gdk_keymap_get_entries_for_keyval(keymap, keyval, &keymapkey, &n_keys)) return false;
341 if (n_keys !=1) { g_free(keymapkey); return false;}
344 ev.type = GDK_KEY_PRESS;
345 ev.window = gtk_widget_get_window(GTK_WIDGET(w->gobj()));
346 ev.send_event = FALSE;
351 ev.string = (gchar*) "";
352 ev.hardware_keycode = keymapkey[0].keycode;
353 ev.group = keymapkey[0].group;
356 forward_key_press(&ev);
357 ev.type = GDK_KEY_RELEASE;
358 return forward_key_press(&ev);
362 key_press_focus_accelerator_handler (Gtk::Window& window, GdkEventKey* ev)
364 GtkWindow* win = window.gobj();
365 GtkWidget* focus = gtk_window_get_focus (win);
366 bool special_handling_of_unmodified_accelerators = false;
367 bool allow_activating = true;
368 /* consider all relevant modifiers but not LOCK or SHIFT */
369 const guint mask = (Keyboard::RelevantModifierKeyMask & ~(Gdk::SHIFT_MASK|Gdk::LOCK_MASK));
372 if (GTK_IS_ENTRY(focus) || Keyboard::some_magic_widget_has_focus()) {
373 special_handling_of_unmodified_accelerators = true;
378 /* at one time this appeared to be necessary. As of July 2012, it does not
379 appear to be. if it ever is necessar, figure out if it should apply
383 if (Keyboard::some_magic_widget_has_focus ()) {
384 allow_activating = false;
390 DEBUG_TRACE (DEBUG::Accelerators, string_compose ("Win = %1 focus = %7 Key event: code = %2 state = %3 special handling ? %4 magic widget focus ? %5 allow_activation ? %6\n",
394 special_handling_of_unmodified_accelerators,
395 Keyboard::some_magic_widget_has_focus(),
399 /* This exists to allow us to override the way GTK handles
400 key events. The normal sequence is:
402 a) event is delivered to a GtkWindow
403 b) accelerators/mnemonics are activated
404 c) if (b) didn't handle the event, propagate to
405 the focus widget and/or focus chain
407 The problem with this is that if the accelerators include
408 keys without modifiers, such as the space bar or the
409 letter "e", then pressing the key while typing into
410 a text entry widget results in the accelerator being
411 activated, instead of the desired letter appearing
414 There is no good way of fixing this, but this
415 represents a compromise. The idea is that
416 key events involving modifiers (not Shift)
417 get routed into the activation pathway first, then
418 get propagated to the focus widget if necessary.
420 If the key event doesn't involve modifiers,
421 we deliver to the focus widget first, thus allowing
422 it to get "normal text" without interference
425 Of course, this can also be problematic: if there
426 is a widget with focus, then it will swallow
427 all "normal text" accelerators.
430 if (!special_handling_of_unmodified_accelerators) {
432 /* XXX note that for a brief moment, the conditional above
433 * included "|| (ev->state & mask)" so as to enforce the
434 * implication of special_handling_of_UNMODIFIED_accelerators.
435 * however, this forces any key that GTK doesn't allow and that
436 * we have an alternative (see next comment) for to be
437 * automatically sent through the accel groups activation
438 * pathway, which prevents individual widgets & canvas items
439 * from ever seeing it if is used by a key binding.
441 * specifically, this hid Ctrl-down-arrow from MIDI region
442 * views because it is also bound to an action.
444 * until we have a robust, clean binding system, this
445 * quirk will have to remain in place.
448 /* pretend that certain key events that GTK does not allow
449 to be used as accelerators are actually something that
450 it does allow. but only where there are no modifiers.
453 uint32_t fakekey = ev->keyval;
455 if (Gtkmm2ext::possibly_translate_keyval_to_make_legal_accelerator (fakekey)) {
456 DEBUG_TRACE (DEBUG::Accelerators, string_compose ("\tactivate (was %1 now %2) without special hanlding of unmodified accels\n",
457 ev->keyval, fakekey));
459 GdkModifierType mod = GdkModifierType (ev->state);
461 mod = GdkModifierType (mod & gtk_accelerator_get_default_mod_mask());
463 /* GTK on OS X is currently (February 2012) setting both
464 the Meta and Mod2 bits in the event modifier state if
465 the Command key is down.
467 gtk_accel_groups_activate() does not invoke any of the logic
468 that gtk_window_activate_key() will that sorts out that stupid
469 state of affairs, and as a result it fails to find a match
470 for the key event and the current set of accelerators.
472 to fix this, if the meta bit is set, remove the mod2 bit
473 from the modifier. this assumes that our bindings use Primary
474 which will have set the meta bit in the accelerator entry.
476 if (mod & GDK_META_MASK) {
477 mod = GdkModifierType (mod & ~GDK_MOD2_MASK);
481 if (allow_activating && gtk_accel_groups_activate(G_OBJECT(win), fakekey, mod)) {
482 DEBUG_TRACE (DEBUG::Accelerators, "\taccel group activated by fakekey\n");
488 if (!special_handling_of_unmodified_accelerators || (ev->state & mask)) {
490 /* no special handling or there are modifiers in effect: accelerate first */
492 DEBUG_TRACE (DEBUG::Accelerators, "\tactivate, then propagate\n");
493 DEBUG_TRACE (DEBUG::Accelerators, string_compose ("\tevent send-event:%1 time:%2 length:%3 string:%4 hardware_keycode:%5 group:%6\n",
494 ev->send_event, ev->time, ev->length, ev->string, ev->hardware_keycode, ev->group));
496 if (allow_activating) {
497 DEBUG_TRACE (DEBUG::Accelerators, "\tsending to window\n");
498 if (gtk_window_activate_key (win, ev)) {
499 DEBUG_TRACE (DEBUG::Accelerators, "\t\thandled\n");
503 DEBUG_TRACE (DEBUG::Accelerators, "\tactivation skipped\n");
506 DEBUG_TRACE (DEBUG::Accelerators, "\tnot accelerated, now propagate\n");
508 return gtk_window_propagate_key_event (win, ev);
511 /* no modifiers, propagate first */
513 DEBUG_TRACE (DEBUG::Accelerators, "\tpropagate, then activate\n");
515 if (!gtk_window_propagate_key_event (win, ev)) {
516 DEBUG_TRACE (DEBUG::Accelerators, "\tpropagation didn't handle, so activate\n");
517 if (allow_activating) {
518 return gtk_window_activate_key (win, ev);
520 DEBUG_TRACE (DEBUG::Accelerators, "\tactivation skipped\n");
524 DEBUG_TRACE (DEBUG::Accelerators, "\thandled by propagate\n");
528 DEBUG_TRACE (DEBUG::Accelerators, "\tnot handled\n");
532 Glib::RefPtr<Gdk::Pixbuf>
533 get_xpm (std::string name)
535 if (!xpm_map[name]) {
537 SearchPath spath(ARDOUR::ardour_data_search_path());
539 spath.add_subdirectory_to_paths("pixmaps");
541 std::string data_file_path;
543 if(!find_file_in_search_path (spath, name, data_file_path)) {
544 fatal << string_compose (_("cannot find XPM file for %1"), name) << endmsg;
548 xpm_map[name] = Gdk::Pixbuf::create_from_file (data_file_path);
549 } catch(const Glib::Error& e) {
550 warning << "Caught Glib::Error: " << e.what() << endmsg;
554 return xpm_map[name];
558 get_icon_path (const char* cname)
563 SearchPath spath(ARDOUR::ardour_data_search_path());
565 spath.add_subdirectory_to_paths("icons");
567 std::string data_file_path;
569 if (!find_file_in_search_path (spath, name, data_file_path)) {
570 fatal << string_compose (_("cannot find icon image for %1 using %2"), name, spath.to_string()) << endmsg;
573 return data_file_path;
576 Glib::RefPtr<Gdk::Pixbuf>
577 get_icon (const char* cname)
579 Glib::RefPtr<Gdk::Pixbuf> img;
581 img = Gdk::Pixbuf::create_from_file (get_icon_path (cname));
582 } catch (const Gdk::PixbufError &e) {
583 cerr << "Caught PixbufError: " << e.what() << endl;
585 error << string_compose (_("Caught exception while loading icon named %1"), cname) << endmsg;
592 longest (vector<string>& strings)
594 if (strings.empty()) {
598 vector<string>::iterator longest = strings.begin();
599 string::size_type longest_length = (*longest).length();
601 vector<string>::iterator i = longest;
604 while (i != strings.end()) {
606 string::size_type len = (*i).length();
608 if (len > longest_length) {
610 longest_length = len;
620 key_is_legal_for_numeric_entry (guint keyval)
622 /* we assume that this does not change over the life of the process
625 static int comma_decimal = -1;
630 if (comma_decimal < 0) {
631 std::lconv* lc = std::localeconv();
632 if (strchr (lc->decimal_point, ',') != 0) {
644 case GDK_decimalpoint:
645 case GDK_KP_Separator:
675 case GDK_KP_Subtract:
704 set_pango_fontsize ()
706 long val = ARDOUR::Config->get_font_scale();
708 /* FT2 rendering - used by GnomeCanvas, sigh */
711 pango_ft2_font_map_set_resolution ((PangoFT2FontMap*) pango_ft2_font_map_new(), val/1024, val/1024);
714 /* Cairo rendering, in case there is any */
716 pango_cairo_font_map_set_resolution ((PangoCairoFontMap*) pango_cairo_font_map_get_default(), val/1024);
722 long val = ARDOUR::Config->get_font_scale();
723 set_pango_fontsize ();
726 gtk_settings_set_long_property (gtk_settings_get_default(),
727 "gtk-xft-dpi", val, "ardour");
728 DPIReset();//Emit Signal
732 resize_window_to_proportion_of_monitor (Gtk::Window* window, int max_width, int max_height)
734 Glib::RefPtr<Gdk::Screen> screen = window->get_screen ();
735 Gdk::Rectangle monitor_rect;
736 screen->get_monitor_geometry (0, monitor_rect);
738 int const w = std::min (int (monitor_rect.get_width() * 0.8), max_width);
739 int const h = std::min (int (monitor_rect.get_height() * 0.8), max_height);
741 window->resize (w, h);
745 /** Replace _ with __ in a string; for use with menu item text to make underscores displayed correctly */
747 escape_underscores (string const & s)
750 string::size_type const N = s.length ();
752 for (string::size_type i = 0; i < N; ++i) {
763 /** Replace < and > with < and > respectively to make < > display correctly in markup strings */
765 escape_angled_brackets (string const & s)
768 boost::replace_all (o, "<", "<");
769 boost::replace_all (o, ">", ">");
774 unique_random_color (list<Gdk::Color>& used_colors)
780 /* avoid neon/glowing tones by limiting them to the
781 "inner section" (paler) of a color wheel/circle.
784 const int32_t max_saturation = 48000; // 65535 would open up the whole color wheel
786 newcolor.set_red (g_random_int() % max_saturation);
787 newcolor.set_blue (g_random_int() % max_saturation);
788 newcolor.set_green (g_random_int() % max_saturation);
790 if (used_colors.size() == 0) {
791 used_colors.push_back (newcolor);
795 for (list<Gdk::Color>::iterator i = used_colors.begin(); i != used_colors.end(); ++i) {
797 float rdelta, bdelta, gdelta;
799 rdelta = newcolor.get_red() - c.get_red();
800 bdelta = newcolor.get_blue() - c.get_blue();
801 gdelta = newcolor.get_green() - c.get_green();
803 if (sqrt (rdelta*rdelta + bdelta*bdelta + gdelta*gdelta) > 25.0) {
804 used_colors.push_back (newcolor);
809 /* XXX need throttle here to make sure we don't spin for ever */