Speed up AFL/PFL changes for large sessions
[ardour.git] / gtk2_ardour / ui_config.cc
1 /*
2     Copyright (C) 1999-2014 Paul Davis
3
4     This program is free software; you can 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.
8
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.
13
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.
17
18 */
19
20 #if !defined USE_CAIRO_IMAGE_SURFACE && !defined NDEBUG
21 #define OPTIONAL_CAIRO_IMAGE_SURFACE
22 #endif
23
24 #include <iostream>
25 #include <sstream>
26 #include <unistd.h>
27 #include <cstdlib>
28 #include <cstdio> /* for snprintf, grrr */
29
30 #include <cairo/cairo.h>
31
32 #include <pango/pangoft2.h> // for fontmap resolution control for GnomeCanvas
33 #include <pango/pangocairo.h> // for fontmap resolution control for GnomeCanvas
34
35 #include <glibmm/miscutils.h>
36
37 #include <gtkmm/settings.h>
38
39 #include "pbd/convert.h"
40 #include "pbd/error.h"
41 #include "pbd/failed_constructor.h"
42 #include "pbd/file_utils.h"
43 #include "pbd/gstdio_compat.h"
44 #include "pbd/locale_guard.h"
45 #include "pbd/unwind.h"
46 #include "pbd/xml++.h"
47
48 #include "ardour/filesystem_paths.h"
49 #include "ardour/search_paths.h"
50 #include "ardour/revision.h"
51 #include "ardour/utils.h"
52
53 #include "gtkmm2ext/rgb_macros.h"
54 #include "gtkmm2ext/gtk_ui.h"
55
56 #include "ui_config.h"
57
58 #include "pbd/i18n.h"
59
60 using namespace std;
61 using namespace PBD;
62 using namespace ARDOUR;
63 using namespace ArdourCanvas;
64
65 static const char* ui_config_file_name = "ui_config";
66 static const char* default_ui_config_file_name = "default_ui_config";
67
68 static const double hue_width = 18.0;
69 std::string UIConfiguration::color_file_suffix = X_(".colors");
70
71 UIConfiguration&
72 UIConfiguration::instance ()
73 {
74         static UIConfiguration s_instance;
75         return s_instance;
76 }
77
78 UIConfiguration::UIConfiguration ()
79         :
80 #undef  UI_CONFIG_VARIABLE
81 #define UI_CONFIG_VARIABLE(Type,var,name,val) var (name,val),
82 #define CANVAS_FONT_VARIABLE(var,name) var (name),
83 #include "ui_config_vars.h"
84 #include "canvas_vars.h"
85 #undef  UI_CONFIG_VARIABLE
86 #undef  CANVAS_FONT_VARIABLE
87
88         _dirty (false),
89         aliases_modified (false),
90         colors_modified (false),
91         modifiers_modified (false),
92         block_save (0)
93 {
94         load_state();
95
96         ColorsChanged.connect (boost::bind (&UIConfiguration::colors_changed, this));
97
98         ParameterChanged.connect (sigc::mem_fun (*this, &UIConfiguration::parameter_changed));
99 }
100
101 UIConfiguration::~UIConfiguration ()
102 {
103 }
104
105 void
106 UIConfiguration::colors_changed ()
107 {
108         reset_gtk_theme ();
109
110         /* In theory, one of these ought to work:
111
112            gtk_rc_reparse_all_for_settings (gtk_settings_get_default(), true);
113            gtk_rc_reset_styles (gtk_settings_get_default());
114
115            but in practice, neither of them do. So just reload the current
116            GTK RC file, which causes a reset of all styles and a redraw
117         */
118
119         parameter_changed ("ui-rc-file");
120 }
121
122 void
123 UIConfiguration::parameter_changed (string param)
124 {
125         _dirty = true;
126
127         if (param == "ui-rc-file") {
128                 load_rc_file (true);
129         } else if (param == "color-file") {
130                 load_color_theme (true);
131         }
132
133         save_state ();
134 }
135
136 void
137 UIConfiguration::reset_gtk_theme ()
138 {
139         LocaleGuard lg;
140         stringstream ss;
141
142         ss << "gtk_color_scheme = \"" << hex;
143
144         for (ColorAliases::iterator g = color_aliases.begin(); g != color_aliases.end(); ++g) {
145
146                 if (g->first.find ("gtk_") == 0) {
147                         const string gtk_name = g->first.substr (4);
148                         ss << gtk_name << ":#" << std::setw (6) << setfill ('0') << (color (g->second) >> 8) << ';';
149                 }
150         }
151
152         ss << '"' << dec << endl;
153
154         /* reset GTK color scheme */
155
156         Gtk::Settings::get_default()->property_gtk_color_scheme() = ss.str();
157 }
158
159 void
160 UIConfiguration::reset_dpi ()
161 {
162         long val = get_font_scale();
163
164         /* FT2 rendering - used by GnomeCanvas, sigh */
165
166 #ifndef PLATFORM_WINDOWS
167         pango_ft2_font_map_set_resolution ((PangoFT2FontMap*) pango_ft2_font_map_new(), val/1024, val/1024);
168 #endif
169
170         /* Cairo rendering, in case there is any */
171
172         pango_cairo_font_map_set_resolution ((PangoCairoFontMap*) pango_cairo_font_map_get_default(), val/1024);
173
174         /* Xft rendering */
175
176         gtk_settings_set_long_property (gtk_settings_get_default(),
177                                         "gtk-xft-dpi", val, "ardour");
178         DPIReset(); //Emit Signal
179 }
180
181 float
182 UIConfiguration::get_ui_scale ()
183 {
184         return get_font_scale () / 102400.;
185 }
186
187 void
188 UIConfiguration::map_parameters (boost::function<void (std::string)>& functor)
189 {
190 #undef  UI_CONFIG_VARIABLE
191 #define UI_CONFIG_VARIABLE(Type,var,Name,value) functor (Name);
192 #include "ui_config_vars.h"
193 #undef  UI_CONFIG_VARIABLE
194 }
195
196 int
197 UIConfiguration::pre_gui_init ()
198 {
199 #ifdef CAIRO_SUPPORTS_FORCE_BUGGY_GRADIENTS_ENVIRONMENT_VARIABLE
200         if (get_buggy_gradients()) {
201                 g_setenv ("FORCE_BUGGY_GRADIENTS", "1", 1);
202         }
203 #endif
204 #ifdef OPTIONAL_CAIRO_IMAGE_SURFACE
205         if (get_cairo_image_surface()) {
206                 g_setenv ("ARDOUR_IMAGE_SURFACE", "1", 1);
207         }
208 #endif
209         return 0;
210 }
211
212 UIConfiguration*
213 UIConfiguration::post_gui_init ()
214 {
215         load_color_theme (true);
216         return this;
217 }
218
219 int
220 UIConfiguration::load_defaults ()
221 {
222         std::string rcfile;
223         int ret = -1;
224
225         if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile) ) {
226                 XMLTree tree;
227
228                 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
229
230                 if (!tree.read (rcfile.c_str())) {
231                         error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
232                 } else {
233                         if (set_state (*tree.root(), Stateful::loading_state_version)) {
234                                 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
235                         } else {
236                                 _dirty = false;
237                                 ret = 0;
238                         }
239                 }
240
241         } else {
242                 warning << string_compose (_("Could not find default UI configuration file %1"), default_ui_config_file_name) << endmsg;
243         }
244
245
246         if (ret == 0) {
247                 /* reload color theme */
248                 load_color_theme (false);
249         }
250
251         return ret;
252 }
253
254 std::string
255 UIConfiguration::color_file_name (bool use_my, bool with_version) const
256 {
257         string basename;
258
259         if (use_my) {
260                 basename += "my-";
261         }
262
263         //this is the overall theme file, e.g. "dark" plus "-downcase(PROGRAM_NAME)"
264         basename += color_file.get();  
265
266         std::string rev (revision);
267         std::size_t pos = rev.find_first_of("-");
268
269         if (with_version && pos != string::npos && pos > 0) {
270                 basename += "-";
271                 basename += rev.substr (0, pos); // COLORFILE_VERSION - program major.minor
272         }
273
274         basename += color_file_suffix;
275         return basename;
276 }
277
278 int
279 UIConfiguration::load_color_file (string const & path)
280 {
281         XMLTree tree;
282
283         info << string_compose (_("Loading color file %1"), path) << endmsg;
284
285         if (!tree.read (path.c_str())) {
286                 error << string_compose(_("cannot read color file \"%1\""), path) << endmsg;
287                 return -1;
288         }
289
290         if (set_state (*tree.root(), Stateful::loading_state_version)) {
291                 error << string_compose(_("color file \"%1\" not loaded successfully."), path) << endmsg;
292                 return -1;
293         }
294
295         return 0;
296 }
297
298 int
299 UIConfiguration::load_color_theme (bool allow_own)
300 {
301         std::string cfile;
302         bool found = false;
303         /* ColorsChanged() will trigger a  parameter_changed () which
304          * in turn calls save_state()
305          */
306         PBD::Unwinder<uint32_t> uw (block_save, block_save + 1);
307
308         if (find_file (theme_search_path(), color_file_name (false, true), cfile)) {
309                 found = true;
310         }
311
312         if (!found) {
313                 if (find_file (theme_search_path(), color_file_name (false, false), cfile)) {
314                         found = true;
315                 }
316         }
317
318         if (!found) {
319                 warning << string_compose (_("Color file for %1 not found along %2"), color_file.get(), theme_search_path().to_string()) << endmsg;
320                 return -1;
321         }
322
323         (void) load_color_file (cfile);
324
325         if (allow_own) {
326
327                 found = false;
328
329                 PBD::Searchpath sp (user_config_directory());
330
331                 /* user's own color files never have the program name in them */
332
333                 if (find_file (sp, color_file_name (true, true), cfile)) {
334                         found = true;
335                 }
336
337                 if (!found) {
338                         if (find_file (sp, color_file_name (true, false), cfile)) {
339                                 found = true;
340                         }
341                 }
342
343                 if (found) {
344                         (void) load_color_file (cfile);
345                 }
346
347         }
348
349         ColorsChanged ();
350
351         return 0;
352 }
353
354 int
355 UIConfiguration::store_color_theme ()
356 {
357         XMLNode* root;
358         LocaleGuard lg;
359
360         root = new XMLNode("Ardour");
361
362         XMLNode* parent = new XMLNode (X_("Colors"));
363         for (Colors::const_iterator i = colors.begin(); i != colors.end(); ++i) {
364                 XMLNode* node = new XMLNode (X_("Color"));
365                 node->add_property (X_("name"), i->first);
366                 stringstream ss;
367                 ss << "0x" << setw (8) << setfill ('0') << hex << i->second;
368                 node->add_property (X_("value"), ss.str());
369                 parent->add_child_nocopy (*node);
370         }
371         root->add_child_nocopy (*parent);
372
373         parent = new XMLNode (X_("ColorAliases"));
374         for (ColorAliases::const_iterator i = color_aliases.begin(); i != color_aliases.end(); ++i) {
375                 XMLNode* node = new XMLNode (X_("ColorAlias"));
376                 node->add_property (X_("name"), i->first);
377                 node->add_property (X_("alias"), i->second);
378                 parent->add_child_nocopy (*node);
379         }
380         root->add_child_nocopy (*parent);
381
382         parent = new XMLNode (X_("Modifiers"));
383         for (Modifiers::const_iterator i = modifiers.begin(); i != modifiers.end(); ++i) {
384                 XMLNode* node = new XMLNode (X_("Modifier"));
385                 node->add_property (X_("name"), i->first);
386                 node->add_property (X_("modifier"), i->second.to_string());
387                 parent->add_child_nocopy (*node);
388         }
389         root->add_child_nocopy (*parent);
390
391         XMLTree tree;
392         std::string colorfile = Glib::build_filename (user_config_directory(), color_file_name (true, true));;
393
394         tree.set_root (root);
395
396         if (!tree.write (colorfile.c_str())){
397                 error << string_compose (_("Color file %1 not saved"), colorfile) << endmsg;
398                 return -1;
399         }
400
401         return 0;
402 }
403
404 int
405 UIConfiguration::load_state ()
406 {
407         LocaleGuard lg; // a single guard for all 3 configs
408         bool found = false;
409
410         std::string rcfile;
411
412         if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile)) {
413                 XMLTree tree;
414                 found = true;
415
416                 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
417
418                 if (!tree.read (rcfile.c_str())) {
419                         error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
420                         return -1;
421                 }
422
423                 if (set_state (*tree.root(), Stateful::loading_state_version)) {
424                         error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
425                         return -1;
426                 }
427         }
428
429         if (find_file (ardour_config_search_path(), ui_config_file_name, rcfile)) {
430                 XMLTree tree;
431                 found = true;
432
433                 info << string_compose (_("Loading user ui configuration file %1"), rcfile) << endmsg;
434
435                 if (!tree.read (rcfile)) {
436                         error << string_compose(_("cannot read ui configuration file \"%1\""), rcfile) << endmsg;
437                         return -1;
438                 }
439
440                 if (set_state (*tree.root(), Stateful::loading_state_version)) {
441                         error << string_compose(_("user ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
442                         return -1;
443                 }
444
445                 _dirty = false;
446         }
447
448         if (!found) {
449                 error << _("could not find any ui configuration file, canvas will look broken.") << endmsg;
450         }
451
452         return 0;
453 }
454
455 int
456 UIConfiguration::save_state()
457 {
458         if (block_save != 0) {
459                 return -1;
460         }
461
462         if (_dirty) {
463                 std::string rcfile = Glib::build_filename (user_config_directory(), ui_config_file_name);
464
465                 XMLTree tree;
466
467                 tree.set_root (&get_state());
468
469                 if (!tree.write (rcfile.c_str())){
470                         error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
471                         return -1;
472                 }
473
474                 _dirty = false;
475         }
476
477         if (aliases_modified || colors_modified || modifiers_modified) {
478
479                 if (store_color_theme ()) {
480                         error << string_compose (_("Color file %1 not saved"), color_file.get()) << endmsg;
481                         return -1;
482                 }
483
484                 aliases_modified = false;
485                 colors_modified = false;
486                 modifiers_modified = false;
487         }
488
489
490         return 0;
491 }
492
493 XMLNode&
494 UIConfiguration::get_state ()
495 {
496         XMLNode* root;
497         LocaleGuard lg;
498
499         root = new XMLNode("Ardour");
500
501         root->add_child_nocopy (get_variables ("UI"));
502         root->add_child_nocopy (get_variables ("Canvas"));
503
504         if (_extra_xml) {
505                 root->add_child_copy (*_extra_xml);
506         }
507
508         return *root;
509 }
510
511 XMLNode&
512 UIConfiguration::get_variables (std::string which_node)
513 {
514         XMLNode* node;
515         LocaleGuard lg;
516
517         node = new XMLNode (which_node);
518
519 #undef  UI_CONFIG_VARIABLE
520 #undef  CANVAS_FONT_VARIABLE
521 #define UI_CONFIG_VARIABLE(Type,var,Name,value) if (node->name() == "UI") { var.add_to_node (*node); }
522 #define CANVAS_FONT_VARIABLE(var,Name) if (node->name() == "Canvas") { var.add_to_node (*node); }
523 #include "ui_config_vars.h"
524 #include "canvas_vars.h"
525 #undef  UI_CONFIG_VARIABLE
526 #undef  CANVAS_FONT_VARIABLE
527
528         return *node;
529 }
530
531 int
532 UIConfiguration::set_state (const XMLNode& root, int /*version*/)
533 {
534         LocaleGuard lg;
535         /* this can load a generic UI configuration file or a colors file */
536
537         if (root.name() != "Ardour") {
538                 return -1;
539         }
540
541         Stateful::save_extra_xml (root);
542
543         XMLNodeList nlist = root.children();
544         XMLNodeConstIterator niter;
545         XMLNode *node;
546
547         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
548
549                 node = *niter;
550
551                 if (node->name() == "Canvas" ||  node->name() == "UI") {
552                         set_variables (*node);
553
554                 }
555         }
556
557         XMLNode* colors = find_named_node (root, X_("Colors"));
558
559         if (colors) {
560                 load_colors (*colors);
561         }
562
563         XMLNode* aliases = find_named_node (root, X_("ColorAliases"));
564
565         if (aliases) {
566                 load_color_aliases (*aliases);
567         }
568
569         XMLNode* modifiers = find_named_node (root, X_("Modifiers"));
570
571         if (modifiers) {
572                 load_modifiers (*modifiers);
573         }
574
575         return 0;
576 }
577
578 void
579 UIConfiguration::load_color_aliases (XMLNode const & node)
580 {
581         XMLNodeList const nlist = node.children();
582         XMLNodeConstIterator niter;
583         XMLProperty const *name;
584         XMLProperty const *alias;
585
586         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
587                 XMLNode const * child = *niter;
588                 if (child->name() != X_("ColorAlias")) {
589                         continue;
590                 }
591                 name = child->property (X_("name"));
592                 alias = child->property (X_("alias"));
593
594                 if (name && alias) {
595                         color_aliases[name->value()] = alias->value();
596                 }
597         }
598 }
599
600 void
601 UIConfiguration::load_colors (XMLNode const & node)
602 {
603         XMLNodeList const nlist = node.children();
604         XMLNodeConstIterator niter;
605         XMLProperty const *name;
606         XMLProperty const *color;
607
608         /* don't clear colors, so that we can load > 1 color file and have
609            the subsequent ones overwrite the later ones.
610         */
611
612         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
613                 XMLNode const * child = *niter;
614                 if (child->name() != X_("Color")) {
615                         continue;
616                 }
617                 name = child->property (X_("name"));
618                 color = child->property (X_("value"));
619
620                 if (name && color) {
621                         ArdourCanvas::Color c;
622                         c = strtoul (color->value().c_str(), 0, 16);
623                         /* insert or replace color name definition */
624                         colors[name->value()] =  c;
625                 }
626         }
627 }
628
629 void
630 UIConfiguration::load_modifiers (XMLNode const & node)
631 {
632         PBD::LocaleGuard lg;
633         XMLNodeList const nlist = node.children();
634         XMLNodeConstIterator niter;
635         XMLProperty const *name;
636         XMLProperty const *mod;
637
638         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
639                 XMLNode const * child = *niter;
640                 if (child->name() != X_("Modifier")) {
641                         continue;
642                 }
643
644                 name = child->property (X_("name"));
645                 mod = child->property (X_("modifier"));
646
647                 if (name && mod) {
648                         SVAModifier svam (mod->value());
649                         modifiers[name->value()] = svam;
650                 }
651         }
652 }
653
654 void
655 UIConfiguration::set_variables (const XMLNode& node)
656 {
657 #undef  UI_CONFIG_VARIABLE
658 #define UI_CONFIG_VARIABLE(Type,var,name,val) if (var.set_from_node (node)) { ParameterChanged (name); }
659 #define CANVAS_FONT_VARIABLE(var,name)        if (var.set_from_node (node)) { ParameterChanged (name); }
660 #include "ui_config_vars.h"
661 #include "canvas_vars.h"
662 #undef  UI_CONFIG_VARIABLE
663 #undef  CANVAS_FONT_VARIABLE
664 }
665
666 ArdourCanvas::SVAModifier
667 UIConfiguration::modifier (string const & name) const
668 {
669         Modifiers::const_iterator m = modifiers.find (name);
670         if (m != modifiers.end()) {
671                 return m->second;
672         }
673         return SVAModifier ();
674 }
675
676 ArdourCanvas::Color
677 UIConfiguration::color_mod (std::string const & colorname, std::string const & modifiername) const
678 {
679         return HSV (color (colorname)).mod (modifier (modifiername)).color ();
680 }
681
682 ArdourCanvas::Color
683 UIConfiguration::color_mod (const ArdourCanvas::Color& color, std::string const & modifiername) const
684 {
685         return HSV (color).mod (modifier (modifiername)).color ();
686 }
687
688 ArdourCanvas::Color
689 UIConfiguration::color (const std::string& name, bool* failed) const
690 {
691         ColorAliases::const_iterator e = color_aliases.find (name);
692
693         if (failed) {
694                 *failed = false;
695         }
696
697         if (e != color_aliases.end ()) {
698                 Colors::const_iterator rc = colors.find (e->second);
699                 if (rc != colors.end()) {
700                         return rc->second;
701                 }
702         } else {
703                 /* not an alias, try directly */
704                 Colors::const_iterator rc = colors.find (name);
705                 if (rc != colors.end()) {
706                         return rc->second;
707                 }
708         }
709
710         if (!failed) {
711                 /* only show this message if the caller wasn't interested in
712                    the fail status.
713                 */
714                 cerr << string_compose (_("Color %1 not found"), name) << endl;
715         }
716
717         if (failed) {
718                 *failed = true;
719         }
720
721         return rgba_to_color ((g_random_int()%256)/255.0,
722                               (g_random_int()%256)/255.0,
723                               (g_random_int()%256)/255.0,
724                               0xff);
725 }
726
727 Color
728 UIConfiguration::quantized (Color c) const
729 {
730         HSV hsv (c);
731         hsv.h = hue_width * (round (hsv.h/hue_width));
732         return hsv.color ();
733 }
734
735 void
736 UIConfiguration::set_color (string const& name, ArdourCanvas::Color color)
737 {
738         Colors::iterator i = colors.find (name);
739         if (i == colors.end()) {
740                 return;
741         }
742         i->second = color;
743         colors_modified = true;
744
745         ColorsChanged (); /* EMIT SIGNAL */
746 }
747
748 void
749 UIConfiguration::set_alias (string const & name, string const & alias)
750 {
751         ColorAliases::iterator i = color_aliases.find (name);
752         if (i == color_aliases.end()) {
753                 return;
754         }
755
756         i->second = alias;
757         aliases_modified = true;
758
759         ColorsChanged (); /* EMIT SIGNAL */
760 }
761
762 void
763 UIConfiguration::set_modifier (string const & name, SVAModifier svam)
764 {
765         Modifiers::iterator m = modifiers.find (name);
766
767         if (m == modifiers.end()) {
768                 return;
769         }
770
771         m->second = svam;
772         modifiers_modified = true;
773
774         ColorsChanged (); /* EMIT SIGNAL */
775 }
776
777 void
778 UIConfiguration::load_rc_file (bool themechange, bool allow_own)
779 {
780         string basename = ui_rc_file.get();
781         std::string rc_file_path;
782
783         if (!find_file (ardour_config_search_path(), basename, rc_file_path)) {
784                 warning << string_compose (_("Unable to find UI style file %1 in search path %2. %3 will look strange"),
785                                            basename, ardour_config_search_path().to_string(), PROGRAM_NAME)
786                                 << endmsg;
787                 return;
788         }
789
790         info << "Loading ui configuration file " << rc_file_path << endmsg;
791
792         Gtkmm2ext::UI::instance()->load_rcfile (rc_file_path, themechange);
793 }