2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file src/wx/wx_util.cc
22 * @brief Some utility functions and classes.
26 #include "file_picker_ctrl.h"
27 #include "lib/config.h"
29 #include "lib/cross.h"
30 #include <dcp/locale_convert.h>
31 #include <wx/spinctrl.h>
32 #include <wx/splash.h>
33 #include <boost/thread.hpp>
36 using namespace boost;
37 using dcp::locale_convert;
41 create_label (wxWindow* p, wxString t, bool left)
43 create_label (wxWindow* p, wxString t, bool)
51 return new wxStaticText (p, wxID_ANY, t);
54 /** Add a wxStaticText to a wxSizer, aligning it at vertical centre.
55 * @param s Sizer to add to.
56 * @param p Parent window for the wxStaticText.
57 * @param t Text for the wxStaticText.
58 * @param left true if this label is a `left label'; ie the sort
59 * of label which should be right-aligned on OS X.
60 * @param prop Proportion to pass when calling Add() on the wxSizer.
63 add_label_to_sizer (wxSizer* s, wxWindow* p, wxString t, bool left, int prop, int flags)
67 flags |= wxALIGN_RIGHT;
70 wxStaticText* m = create_label (p, t, left);
71 s->Add (m, prop, flags, 6);
77 add_label_to_sizer (wxSizer* s, wxStaticText* t, bool left, int prop, int flags)
79 add_label_to_sizer (wxSizer* s, wxStaticText* t, bool, int prop, int flags)
84 flags |= wxALIGN_RIGHT;
87 s->Add (t, prop, flags, 6);
92 add_label_to_sizer (wxGridBagSizer* s, wxWindow* p, wxString t, bool left, wxGBPosition pos, wxGBSpan span)
94 int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
97 flags |= wxALIGN_RIGHT;
100 wxStaticText* m = create_label (p, t, left);
101 s->Add (m, pos, span, flags);
107 add_label_to_sizer (wxGridBagSizer* s, wxStaticText* t, bool left, wxGBPosition pos, wxGBSpan span)
109 add_label_to_sizer (wxGridBagSizer* s, wxStaticText* t, bool, wxGBPosition pos, wxGBSpan span)
112 int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
115 flags |= wxALIGN_RIGHT;
118 s->Add (t, pos, span, flags);
122 /** Pop up an error dialogue box.
123 * @param parent Parent.
125 * @param e Extended message.
128 error_dialog (wxWindow* parent, wxString m, optional<wxString> e)
130 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxOK | wxICON_ERROR);
132 d->SetExtendedMessage (*e);
138 /** Pop up an error dialogue box.
139 * @param parent Parent.
143 message_dialog (wxWindow* parent, wxString m)
145 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxOK | wxICON_INFORMATION);
151 confirm_dialog (wxWindow* parent, wxString m)
153 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxYES_NO | wxICON_QUESTION);
154 int const r = d->ShowModal ();
156 return r == wxID_YES;
160 /** @param s wxWidgets string.
161 * @return Corresponding STL string.
164 wx_to_std (wxString s)
166 return string (s.ToUTF8 ());
169 /** @param s STL string.
170 * @return Corresponding wxWidgets string.
175 return wxString (s.c_str(), wxConvUTF8);
179 string_client_data (wxClientData* o)
181 return wx_to_std (dynamic_cast<wxStringClientData*>(o)->GetData());
185 checked_set (FilePickerCtrl* widget, boost::filesystem::path value)
187 if (widget->GetPath() != std_to_wx (value.string())) {
189 /* Hack to make wxWidgets clear the control when we are passed
194 widget->SetPath (std_to_wx (value.string()));
199 checked_set (wxSpinCtrl* widget, int value)
201 if (widget->GetValue() != value) {
202 widget->SetValue (value);
207 checked_set (wxSpinCtrlDouble* widget, double value)
209 /* XXX: completely arbitrary epsilon */
210 if (fabs (widget->GetValue() - value) > 1e-16) {
211 widget->SetValue (value);
216 checked_set (wxChoice* widget, int value)
218 if (widget->GetSelection() != value) {
219 widget->SetSelection (value);
224 checked_set (wxChoice* widget, string value)
227 if (widget->GetSelection() != -1) {
228 o = widget->GetClientObject (widget->GetSelection ());
231 if (!o || string_client_data(o) != value) {
232 for (unsigned int i = 0; i < widget->GetCount(); ++i) {
233 if (string_client_data (widget->GetClientObject (i)) == value) {
234 widget->SetSelection (i);
241 checked_set (wxChoice* widget, vector<pair<string, string> > items)
243 vector<pair<string, string> > current;
244 for (unsigned int i = 0; i < widget->GetCount(); ++i) {
247 wx_to_std (widget->GetString (i)),
248 string_client_data (widget->GetClientObject (i))
253 if (current == items) {
258 for (vector<pair<string, string> >::const_iterator i = items.begin(); i != items.end(); ++i) {
259 widget->Append (std_to_wx (i->first), new wxStringClientData (std_to_wx (i->second)));
264 checked_set (wxTextCtrl* widget, string value)
266 if (widget->GetValue() != std_to_wx (value)) {
267 widget->ChangeValue (std_to_wx (value));
272 checked_set (wxTextCtrl* widget, wxString value)
274 if (widget->GetValue() != value) {
275 widget->ChangeValue (value);
280 checked_set (wxStaticText* widget, string value)
282 if (widget->GetLabel() != std_to_wx (value)) {
283 widget->SetLabel (std_to_wx (value));
288 checked_set (wxStaticText* widget, wxString value)
290 if (widget->GetLabel() != value) {
291 widget->SetLabel (value);
296 checked_set (wxCheckBox* widget, bool value)
298 if (widget->GetValue() != value) {
299 widget->SetValue (value);
304 checked_set (wxRadioButton* widget, bool value)
306 if (widget->GetValue() != value) {
307 widget->SetValue (value);
312 dcpomatic_setup_i18n ()
314 int language = wxLANGUAGE_DEFAULT;
316 boost::optional<string> config_lang = Config::instance()->language ();
317 if (config_lang && !config_lang->empty ()) {
318 wxLanguageInfo const * li = wxLocale::FindLanguageInfo (std_to_wx (config_lang.get ()));
320 language = li->Language;
324 wxLocale* locale = 0;
325 if (wxLocale::IsAvailable (language)) {
326 locale = new wxLocale (language, wxLOCALE_LOAD_DEFAULT);
328 #ifdef DCPOMATIC_WINDOWS
329 locale->AddCatalogLookupPathPrefix (std_to_wx (mo_path().string()));
332 #ifdef DCPOMATIC_LINUX
333 locale->AddCatalogLookupPathPrefix (LINUX_LOCALE_PREFIX);
335 /* We have to include the wxWidgets .mo in our distribution,
336 so we rename it to avoid clashes with any other installation
339 locale->AddCatalog (wxT ("dcpomatic2-wxstd"));
342 locale->AddCatalog (wxT ("libdcpomatic2-wx"));
343 locale->AddCatalog (wxT ("dcpomatic2"));
345 if (!locale->IsOk()) {
347 locale = new wxLocale (wxLANGUAGE_ENGLISH);
352 dcpomatic_setup_gettext_i18n (wx_to_std (locale->GetCanonicalName ()));
357 wx_get (wxSpinCtrl* w)
359 return w->GetValue ();
365 return w->GetSelection ();
369 wx_get (wxSpinCtrlDouble* w)
371 return w->GetValue ();
374 /** @param s String of the form Context|String
375 * @return translation, or String if no translation is available.
378 context_translation (wxString s)
380 wxString t = wxGetTranslation (s);
382 /* No translation; strip the context */
383 int c = t.Find (wxT ("|"));
384 if (c != wxNOT_FOUND) {
393 time_to_timecode (DCPTime t, double fps)
395 double w = t.seconds ();
396 int const h = (w / 3600);
398 int const m = (w / 60);
400 int const s = floor (w);
402 int const f = lrint (w * fps);
403 return wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f);
407 setup_audio_channels_choice (wxChoice* choice, int minimum)
409 vector<pair<string, string> > items;
410 for (int i = minimum; i <= 16; i += 2) {
412 items.push_back (make_pair (wx_to_std (_("2 - stereo")), locale_convert<string> (i)));
414 items.push_back (make_pair (wx_to_std (_("4 - L/C/R/Lfe")), locale_convert<string> (i)));
416 items.push_back (make_pair (wx_to_std (_("6 - 5.1")), locale_convert<string> (i)));
418 items.push_back (make_pair (wx_to_std (_("8 - 5.1/HI/VI")), locale_convert<string> (i)));
419 } else if (i == 12) {
420 items.push_back (make_pair (wx_to_std (_("12 - 7.1/HI/VI")), locale_convert<string> (i)));
422 items.push_back (make_pair (locale_convert<string> (i), locale_convert<string> (i)));
426 checked_set (choice, items);
432 wxSplashScreen* splash = 0;
434 if (!Config::have_existing ("config.xml")) {
436 boost::filesystem::path p = shared_path () / "splash.png";
437 if (bitmap.LoadFile (std_to_wx (p.string ()), wxBITMAP_TYPE_PNG)) {
438 splash = new wxSplashScreen (bitmap, wxSPLASH_CENTRE_ON_SCREEN | wxSPLASH_NO_TIMEOUT, 0, 0, -1);
442 } catch (boost::filesystem::filesystem_error& e) {
443 /* Maybe we couldn't find the splash image; never mind */
449 boost::filesystem::path
450 path_from_file_dialog (wxFileDialog* dialog, string extension)
452 return boost::filesystem::path(wx_to_std(dialog->GetPath())).replace_extension(extension);
456 calculate_mark_interval (double mark_interval)
458 if (mark_interval > 5) {
459 mark_interval -= lrint (mark_interval) % 5;
461 if (mark_interval > 10) {
462 mark_interval -= lrint (mark_interval) % 10;
464 if (mark_interval > 60) {
465 mark_interval -= lrint (mark_interval) % 60;
467 if (mark_interval > 3600) {
468 mark_interval -= lrint (mark_interval) % 3600;
471 if (mark_interval < 1) {
475 return mark_interval;