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.
20 #include <pango/pangoft2.h> // for fontmap resolution control for GnomeCanvas
21 #include <pango/pangocairo.h> // for fontmap resolution control for GnomeCanvas
27 #include <libart_lgpl/art_misc.h>
29 #include <gtkmm/window.h>
30 #include <gtkmm/combo.h>
31 #include <gtkmm/label.h>
32 #include <gtkmm/paned.h>
33 #include <gtk/gtkpaned.h>
35 #include "pbd/file_utils.h"
37 #include <gtkmm2ext/utils.h>
38 #include "ardour/configuration.h"
39 #include "ardour/rc_configuration.h"
41 #include "ardour/filesystem_paths.h"
43 #include "ardour_ui.h"
44 #include "public_editor.h"
48 #include "rgb_macros.h"
49 #include "canvas_impl.h"
56 using Gtkmm2ext::Keyboard;
58 sigc::signal<void> DPIReset;
61 pixel_width (const ustring& str, Pango::FontDescription& font)
64 Glib::RefPtr<Pango::Layout> layout = foo.create_pango_layout ("");
66 layout->set_font_description (font);
67 layout->set_text (str);
70 Gtkmm2ext::get_ink_pixel_size (layout, width, height);
75 fit_to_pixels (const ustring& str, int pixel_width, Pango::FontDescription& font, int& actual_width, bool with_ellipses)
78 Glib::RefPtr<Pango::Layout> layout = foo.create_pango_layout ("");
79 ustring::size_type shorter_by = 0;
82 layout->set_font_description (font);
87 ustring::iterator last = ustr.end();
88 --last; /* now points at final entry */
92 while (!ustr.empty()) {
94 layout->set_text (txt);
97 Gtkmm2ext::get_ink_pixel_size (layout, width, height);
99 if (width < pixel_width) {
100 actual_width = width;
107 if (with_ellipses && shorter_by > 3) {
118 /** Try to fit a string into a given horizontal space by ellipsizing it.
119 * @param cr Cairo context in which the text will be plotted.
121 * @param avail Available horizontal space.
122 * @return (Text, possibly ellipsized) and (horizontal size of text)
125 std::pair<std::string, double>
126 fit_to_pixels (cairo_t* cr, std::string name, double avail)
128 /* XXX hopefully there exists a more efficient way of doing this */
130 bool abbreviated = false;
134 cairo_text_extents_t ext;
135 cairo_text_extents (cr, name.c_str(), &ext);
137 if (ext.width < avail || name.length() <= 4) {
143 name = name.substr (0, name.length() - 4) + "...";
145 name = name.substr (0, name.length() - 3) + "...";
150 return std::make_pair (name, width);
154 /** Add an element to a menu, settings its sensitivity.
155 * @param m Menu to add to.
156 * @param e Element to add.
157 * @param s true to make sensitive, false to make insensitive
160 add_item_with_sensitivity (Menu_Helpers::MenuList& m, Menu_Helpers::MenuElem e, bool s)
164 m.back().set_sensitive (false);
170 just_hide_it (GdkEventAny */*ev*/, Gtk::Window *win)
176 /* xpm2rgb copied from nixieclock, which bore the legend:
178 nixieclock - a nixie desktop timepiece
179 Copyright (C) 2000 Greg Ercolano, erco@3dsite.com
181 and was released under the GPL.
185 xpm2rgb (const char** xpm, uint32_t& w, uint32_t& h)
187 static long vals[256], val;
188 uint32_t t, x, y, colors, cpp;
190 unsigned char *savergb, *rgb;
194 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
195 error << string_compose (_("bad XPM header %1"), xpm[0])
200 savergb = rgb = (unsigned char*) malloc (h * w * 3);
202 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
203 for (t = 0; t < colors; ++t) {
204 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
208 // COLORMAP -> RGB CONVERSION
209 // Get low 3 bytes from vals[]
213 for (y = h-1; y > 0; --y) {
215 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 3) {
216 val = vals[(int)*p++];
217 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
218 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
219 *(rgb+0) = val & 0xff; // 0:R
227 xpm2rgba (const char** xpm, uint32_t& w, uint32_t& h)
229 static long vals[256], val;
230 uint32_t t, x, y, colors, cpp;
232 unsigned char *savergb, *rgb;
237 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
238 error << string_compose (_("bad XPM header %1"), xpm[0])
243 savergb = rgb = (unsigned char*) malloc (h * w * 4);
245 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
247 if (strstr (xpm[1], "None")) {
248 sscanf (xpm[1], "%c", &transparent);
255 for (; t < colors; ++t) {
256 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
260 // COLORMAP -> RGB CONVERSION
261 // Get low 3 bytes from vals[]
265 for (y = h-1; y > 0; --y) {
269 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 4) {
271 if (transparent && (*p++ == transparent)) {
279 *(rgb+3) = alpha; // 3: alpha
280 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
281 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
282 *(rgb+0) = val & 0xff; // 0:R
289 ArdourCanvas::Points*
290 get_canvas_points (string /*who*/, uint32_t npoints)
292 // cerr << who << ": wants " << npoints << " canvas points" << endl;
293 #ifdef TRAP_EXCESSIVE_POINT_REQUESTS
294 if (npoints > (uint32_t) gdk_screen_width() + 4) {
298 return new ArdourCanvas::Points (npoints);
301 Pango::FontDescription*
302 get_font_for_style (string widgetname)
304 Gtk::Window window (WINDOW_TOPLEVEL);
306 Glib::RefPtr<Gtk::Style> style;
309 foobar.set_name (widgetname);
310 foobar.ensure_style();
312 style = foobar.get_style ();
314 Glib::RefPtr<const Pango::Layout> layout = foobar.get_layout();
316 PangoFontDescription *pfd = (PangoFontDescription *)pango_layout_get_font_description((PangoLayout *)layout->gobj());
320 /* layout inherited its font description from a PangoContext */
322 PangoContext* ctxt = (PangoContext*) pango_layout_get_context ((PangoLayout*) layout->gobj());
323 pfd = pango_context_get_font_description (ctxt);
324 return new Pango::FontDescription (pfd, true); /* make a copy */
327 return new Pango::FontDescription (pfd, true); /* make a copy */
331 rgba_from_style (string style, uint32_t r, uint32_t g, uint32_t b, uint32_t a, string attr, int state, bool rgba)
333 /* In GTK+2, styles aren't set up correctly if the widget is not
334 attached to a toplevel window that has a screen pointer.
337 static Gtk::Window* window = 0;
340 window = new Window (WINDOW_TOPLEVEL);
347 foo.set_name (style);
350 GtkRcStyle* waverc = foo.get_style()->gobj()->rc_style;
354 r = waverc->fg[state].red / 257;
355 g = waverc->fg[state].green / 257;
356 b = waverc->fg[state].blue / 257;
358 /* what a hack ... "a" is for "active" */
359 if (state == Gtk::STATE_NORMAL && rgba) {
360 a = waverc->fg[GTK_STATE_ACTIVE].red / 257;
362 } else if (attr == "bg") {
364 r = waverc->bg[state].red / 257;
365 g = waverc->bg[state].green / 257;
366 b = waverc->bg[state].blue / 257;
367 } else if (attr == "base") {
368 r = waverc->base[state].red / 257;
369 g = waverc->base[state].green / 257;
370 b = waverc->base[state].blue / 257;
371 } else if (attr == "text") {
372 r = waverc->text[state].red / 257;
373 g = waverc->text[state].green / 257;
374 b = waverc->text[state].blue / 257;
377 warning << string_compose (_("missing RGBA style for \"%1\""), style) << endl;
382 if (state == Gtk::STATE_NORMAL && rgba) {
383 return (uint32_t) RGBA_TO_UINT(r,g,b,a);
385 return (uint32_t) RGB_TO_UINT(r,g,b);
391 color_from_style (string widget_style_name, int state, string attr)
395 style = gtk_rc_get_style_by_paths (gtk_settings_get_default(),
396 widget_style_name.c_str(),
400 error << string_compose (_("no style found for %1, using red"), style) << endmsg;
401 return Gdk::Color ("red");
405 return Gdk::Color (&style->fg[state]);
409 return Gdk::Color (&style->bg[state]);
412 if (attr == "light") {
413 return Gdk::Color (&style->light[state]);
416 if (attr == "dark") {
417 return Gdk::Color (&style->dark[state]);
421 return Gdk::Color (&style->mid[state]);
424 if (attr == "text") {
425 return Gdk::Color (&style->text[state]);
428 if (attr == "base") {
429 return Gdk::Color (&style->base[state]);
432 if (attr == "text_aa") {
433 return Gdk::Color (&style->text_aa[state]);
436 error << string_compose (_("unknown style attribute %1 requested for color; using \"red\""), attr) << endmsg;
437 return Gdk::Color ("red");
440 Glib::RefPtr<Gdk::GC>
441 gc_from_style (string widget_style_name, int state, string attr)
445 style = gtk_rc_get_style_by_paths (gtk_settings_get_default(),
446 widget_style_name.c_str(),
450 error << string_compose (_("no style found for %1, using red"), style) << endmsg;
451 Glib::RefPtr<Gdk::GC> ret = Gdk::GC::create();
452 ret->set_rgb_fg_color(Gdk::Color("red"));
457 return Glib::wrap(style->fg_gc[state]);
461 return Glib::wrap(style->bg_gc[state]);
464 if (attr == "light") {
465 return Glib::wrap(style->light_gc[state]);
468 if (attr == "dark") {
469 return Glib::wrap(style->dark_gc[state]);
473 return Glib::wrap(style->mid_gc[state]);
476 if (attr == "text") {
477 return Glib::wrap(style->text_gc[state]);
480 if (attr == "base") {
481 return Glib::wrap(style->base_gc[state]);
484 if (attr == "text_aa") {
485 return Glib::wrap(style->text_aa_gc[state]);
488 error << string_compose (_("unknown style attribute %1 requested for color; using \"red\""), attr) << endmsg;
489 Glib::RefPtr<Gdk::GC> ret = Gdk::GC::create();
490 ret->set_rgb_fg_color(Gdk::Color("red"));
496 canvas_item_visible (ArdourCanvas::Item* item)
498 return (item->gobj()->object.flags & GNOME_CANVAS_ITEM_VISIBLE) ? true : false;
502 set_color (Gdk::Color& c, int rgb)
504 c.set_rgb((rgb >> 16)*256, ((rgb & 0xff00) >> 8)*256, (rgb & 0xff)*256);
509 gboolean gdk_quartz_possibly_forward (GdkEvent*);
514 relay_key_press (GdkEventKey* ev, Gtk::Window* win)
516 if (!key_press_focus_accelerator_handler (*win, ev)) {
517 return PublicEditor::instance().on_key_press_event(ev);
524 key_press_focus_accelerator_handler (Gtk::Window& window, GdkEventKey* ev)
526 GtkWindow* win = window.gobj();
527 GtkWidget* focus = gtk_window_get_focus (win);
528 bool special_handling_of_unmodified_accelerators = false;
529 bool allow_activating = true;
531 #undef DEBUG_ACCELERATOR_HANDLING
532 #ifdef DEBUG_ACCELERATOR_HANDLING
533 //bool debug = (getenv ("ARDOUR_DEBUG_ACCELERATOR_HANDLING") != 0);
537 if (GTK_IS_ENTRY(focus) || Keyboard::some_magic_widget_has_focus()) {
538 special_handling_of_unmodified_accelerators = true;
543 /* should this be universally true? */
544 if (Keyboard::some_magic_widget_has_focus ()) {
545 allow_activating = false;
549 #ifdef DEBUG_ACCELERATOR_HANDLING
551 cerr << "Win = " << win << " Key event: code = " << ev->keyval << " state = " << hex << ev->state << dec << " special handling ? "
552 << special_handling_of_unmodified_accelerators
553 << " magic widget focus ? "
554 << Keyboard::some_magic_widget_has_focus()
555 << " allow_activation ? "
561 /* This exists to allow us to override the way GTK handles
562 key events. The normal sequence is:
564 a) event is delivered to a GtkWindow
565 b) accelerators/mnemonics are activated
566 c) if (b) didn't handle the event, propagate to
567 the focus widget and/or focus chain
569 The problem with this is that if the accelerators include
570 keys without modifiers, such as the space bar or the
571 letter "e", then pressing the key while typing into
572 a text entry widget results in the accelerator being
573 activated, instead of the desired letter appearing
576 There is no good way of fixing this, but this
577 represents a compromise. The idea is that
578 key events involving modifiers (not Shift)
579 get routed into the activation pathway first, then
580 get propagated to the focus widget if necessary.
582 If the key event doesn't involve modifiers,
583 we deliver to the focus widget first, thus allowing
584 it to get "normal text" without interference
587 Of course, this can also be problematic: if there
588 is a widget with focus, then it will swallow
589 all "normal text" accelerators.
593 if (!special_handling_of_unmodified_accelerators) {
595 /* pretend that certain key events that GTK does not allow
596 to be used as accelerators are actually something that
600 uint32_t fakekey = ev->keyval;
602 if (possibly_translate_keyval_to_make_legal_accelerator (fakekey)) {
603 if (allow_activating && gtk_accel_groups_activate(G_OBJECT(win), fakekey, GdkModifierType(ev->state))) {
608 if (allow_activating) {
609 int oldval = ev->keyval;
610 ev->keyval = fakekey;
611 if (gdk_quartz_possibly_forward ((GdkEvent*) ev)) {
620 /* consider all relevant modifiers but not LOCK or SHIFT */
622 guint mask = (Keyboard::RelevantModifierKeyMask & ~(Gdk::SHIFT_MASK|Gdk::LOCK_MASK));
624 if (!special_handling_of_unmodified_accelerators || (ev->state & mask)) {
626 /* no special handling or there are modifiers in effect: accelerate first */
628 #ifdef DEBUG_ACCELERATOR_HANDLING
630 cerr << "\tactivate, then propagate\n";
634 if (allow_activating) {
636 if (gdk_quartz_possibly_forward ((GdkEvent*) ev)) {
640 if (gtk_window_activate_key (win, ev)) {
645 #ifdef DEBUG_ACCELERATOR_HANDLING
647 cerr << "\tnot accelerated, now propagate\n";
650 return gtk_window_propagate_key_event (win, ev);
653 /* no modifiers, propagate first */
655 #ifdef DEBUG_ACCELERATOR_HANDLING
657 cerr << "\tpropagate, then activate\n";
660 if (!gtk_window_propagate_key_event (win, ev)) {
661 #ifdef DEBUG_ACCELERATOR_HANDLING
663 cerr << "\tpropagation didn't handle, so activate\n";
667 if (allow_activating) {
670 if (gdk_quartz_possibly_forward ((GdkEvent*) ev)) {
674 return gtk_window_activate_key (win, ev);
678 #ifdef DEBUG_ACCELERATOR_HANDLING
680 cerr << "\thandled by propagate\n";
686 #ifdef DEBUG_ACCELERATOR_HANDLING
688 cerr << "\tnot handled\n";
694 Glib::RefPtr<Gdk::Pixbuf>
695 get_xpm (std::string name)
697 if (!xpm_map[name]) {
699 SearchPath spath(ARDOUR::ardour_search_path());
700 spath += ARDOUR::system_data_search_path();
702 spath.add_subdirectory_to_paths("pixmaps");
704 sys::path data_file_path;
706 if(!find_file_in_search_path (spath, name, data_file_path)) {
707 fatal << string_compose (_("cannot find XPM file for %1"), name) << endmsg;
711 xpm_map[name] = Gdk::Pixbuf::create_from_file (data_file_path.to_string());
712 } catch(const Glib::Error& e) {
713 warning << "Caught Glib::Error: " << e.what() << endmsg;
717 return xpm_map[name];
721 get_icon_path (const char* cname)
726 SearchPath spath(ARDOUR::ardour_search_path());
727 spath += ARDOUR::system_data_search_path();
729 spath.add_subdirectory_to_paths("icons");
731 sys::path data_file_path;
733 if (!find_file_in_search_path (spath, name, data_file_path)) {
734 fatal << string_compose (_("cannot find icon image for %1"), name) << endmsg;
737 return data_file_path.to_string();
740 Glib::RefPtr<Gdk::Pixbuf>
741 get_icon (const char* cname)
743 Glib::RefPtr<Gdk::Pixbuf> img;
745 img = Gdk::Pixbuf::create_from_file (get_icon_path (cname));
746 } catch (const Gdk::PixbufError &e) {
747 cerr << "Caught PixbufError: " << e.what() << endl;
749 g_message("Caught ... ");
756 longest (vector<string>& strings)
758 if (strings.empty()) {
762 vector<string>::iterator longest = strings.begin();
763 string::size_type longest_length = (*longest).length();
765 vector<string>::iterator i = longest;
768 while (i != strings.end()) {
770 string::size_type len = (*i).length();
772 if (len > longest_length) {
774 longest_length = len;
784 key_is_legal_for_numeric_entry (guint keyval)
802 case GDK_KP_Subtract:
831 set_pango_fontsize ()
833 long val = ARDOUR::Config->get_font_scale();
835 /* FT2 rendering - used by GnomeCanvas, sigh */
837 pango_ft2_font_map_set_resolution ((PangoFT2FontMap*) pango_ft2_font_map_for_display(), val/1024, val/1024);
839 /* Cairo rendering, in case there is any */
841 pango_cairo_font_map_set_resolution ((PangoCairoFontMap*) pango_cairo_font_map_get_default(), val/1024);
847 long val = ARDOUR::Config->get_font_scale();
848 set_pango_fontsize ();
851 gtk_settings_set_long_property (gtk_settings_get_default(),
852 "gtk-xft-dpi", val, "ardour");
853 DPIReset();//Emit Signal
857 possibly_translate_keyval_to_make_legal_accelerator (uint32_t& keyval)
859 int fakekey = GDK_VoidSymbol;
863 case GDK_ISO_Left_Tab:
868 fakekey = GDK_uparrow;
872 fakekey = GDK_downarrow;
876 fakekey = GDK_rightarrow;
880 fakekey = GDK_leftarrow;
884 fakekey = GDK_3270_Enter;
895 if (fakekey != GDK_VoidSymbol) {
904 possibly_translate_legal_accelerator_to_real_key (uint32_t keyval)
941 convert_color_channel (guint8 src,
944 return alpha ? ((guint (src) << 8) - src) / alpha : 0;
948 convert_bgra_to_rgba (guint8 const* src,
953 guint8 const* src_pixel = src;
954 guint8* dst_pixel = dst;
956 for (int y = 0; y < height; y++)
957 for (int x = 0; x < width; x++)
959 dst_pixel[0] = convert_color_channel (src_pixel[2],
961 dst_pixel[1] = convert_color_channel (src_pixel[1],
963 dst_pixel[2] = convert_color_channel (src_pixel[0],
965 dst_pixel[3] = src_pixel[3];
973 resize_window_to_proportion_of_monitor (Gtk::Window* window, int max_width, int max_height)
975 Glib::RefPtr<Gdk::Screen> screen = window->get_screen ();
976 Gdk::Rectangle monitor_rect;
977 screen->get_monitor_geometry (0, monitor_rect);
979 int const w = std::min (monitor_rect.get_width(), max_width) * 0.8;
980 int const h = std::min (monitor_rect.get_height(), max_height) * 0.8;
982 window->resize (w, h);
985 Glib::RefPtr<Gdk::Pixbuf>
986 pixbuf_from_ustring(const ustring& name, Pango::FontDescription* font, int clip_width, int clip_height, Gdk::Color fg)
988 static Glib::RefPtr<Gdk::Pixbuf>* empty_pixbuf = 0;
991 if (empty_pixbuf == 0) {
992 empty_pixbuf = new Glib::RefPtr<Gdk::Pixbuf>;
993 *empty_pixbuf = Gdk::Pixbuf::create(Gdk::COLORSPACE_RGB, true, 8, clip_width, clip_height);
995 return *empty_pixbuf;
998 Glib::RefPtr<Gdk::Pixbuf> buf = Gdk::Pixbuf::create(Gdk::COLORSPACE_RGB, true, 8, clip_width, clip_height);
1000 cairo_surface_t* surface = cairo_image_surface_create(CAIRO_FORMAT_ARGB32, clip_width, clip_height);
1001 cairo_t* cr = cairo_create (surface);
1002 cairo_text_extents_t te;
1004 cairo_set_source_rgba (cr, fg.get_red_p(), fg.get_green_p(), fg.get_blue_p(), 1.0);
1005 cairo_select_font_face (cr, font->get_family().c_str(),
1006 CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
1007 cairo_set_font_size (cr, font->get_size() / Pango::SCALE);
1008 cairo_text_extents (cr, name.c_str(), &te);
1010 cairo_move_to (cr, 0.5, 0.5 - te.height / 2 - te.y_bearing + clip_height / 2);
1011 cairo_show_text (cr, name.c_str());
1013 convert_bgra_to_rgba(cairo_image_surface_get_data (surface), buf->get_pixels(), clip_width, clip_height);
1016 cairo_surface_destroy(surface);