2 Copyright (C) 2020-2021 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/>.
22 #include "full_language_tag_dialog.h"
23 #include "lib/dcpomatic_assert.h"
24 #include <dcp/language_tag.h>
25 #include <wx/listctrl.h>
26 #include <wx/srchctrl.h>
28 #include <boost/algorithm/string.hpp>
29 #include <boost/bind/bind.hpp>
30 #include <boost/optional.hpp>
31 #include <boost/signals2.hpp>
39 using std::shared_ptr;
43 using boost::optional;
44 #if BOOST_VERSION >= 106100
45 using namespace boost::placeholders;
49 class SubtagListCtrl : public wxListCtrl
52 SubtagListCtrl (wxWindow* parent)
53 : wxListCtrl (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_SINGLE_SEL | wxLC_NO_HEADER | wxLC_VIRTUAL)
55 AppendColumn ("", wxLIST_FORMAT_LEFT, 80);
56 AppendColumn ("", wxLIST_FORMAT_LEFT, 400);
59 void set (dcp::LanguageTag::SubtagType type, string search, optional<dcp::LanguageTag::SubtagData> subtag = optional<dcp::LanguageTag::SubtagData>())
61 _all_subtags = dcp::LanguageTag::get_all(type);
64 auto i = find(_matching_subtags.begin(), _matching_subtags.end(), *subtag);
65 if (i != _matching_subtags.end()) {
66 auto item = std::distance(_matching_subtags.begin(), i);
67 SetItemState (item, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
71 if (GetItemCount() > 0) {
72 /* The new list sometimes isn't visible without this */
78 void set_search (string search)
81 _matching_subtags = _all_subtags;
83 _matching_subtags.clear ();
85 boost::algorithm::to_lower(search);
86 for (auto const& i: _all_subtags) {
88 (boost::algorithm::to_lower_copy(i.subtag).find(search) != string::npos) ||
89 (boost::algorithm::to_lower_copy(i.description).find(search) != string::npos)) {
90 _matching_subtags.push_back (i);
95 SetItemCount (_matching_subtags.size());
96 if (GetItemCount() > 0) {
97 RefreshItems (0, GetItemCount() - 1);
101 optional<dcp::LanguageTag::SubtagData> selected_subtag () const
103 auto selected = GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
104 if (selected == -1) {
108 DCPOMATIC_ASSERT (static_cast<size_t>(selected) < _matching_subtags.size());
109 return _matching_subtags[selected];
113 wxString OnGetItemText (long item, long column) const override
116 return _matching_subtags[item].subtag;
118 return _matching_subtags[item].description;
122 std::vector<dcp::LanguageTag::SubtagData> _all_subtags;
123 std::vector<dcp::LanguageTag::SubtagData> _matching_subtags;
127 class LanguageSubtagPanel : public wxPanel
130 LanguageSubtagPanel (wxWindow* parent)
131 : wxPanel (parent, wxID_ANY)
134 int const height = 30;
136 int const height = -1;
139 _search = new wxSearchCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(200, height));
140 _list = new SubtagListCtrl (this);
142 auto sizer = new wxBoxSizer (wxVERTICAL);
143 sizer->Add (_search, 0, wxALL, 8);
144 sizer->Add (_list, 1, wxALL, 8);
147 _search->Bind (wxEVT_TEXT, boost::bind(&LanguageSubtagPanel::search_changed, this));
148 _list->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind(&LanguageSubtagPanel::selection_changed, this));
149 _list->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind(&LanguageSubtagPanel::selection_changed, this));
152 void set (dcp::LanguageTag::SubtagType type, string search, optional<dcp::LanguageTag::SubtagData> subtag = optional<dcp::LanguageTag::SubtagData>())
154 _list->set (type, search, subtag);
155 _search->SetValue (wxString(search));
158 optional<dcp::LanguageTag::RegionSubtag> get () const
160 if (!_list->selected_subtag()) {
164 return dcp::LanguageTag::RegionSubtag(_list->selected_subtag()->subtag);
167 boost::signals2::signal<void (optional<dcp::LanguageTag::SubtagData>)> SelectionChanged;
168 boost::signals2::signal<void (string)> SearchChanged;
171 void search_changed ()
173 auto search = _search->GetValue();
174 _list->set_search (search.ToStdString());
175 if (search.Length() > 0 && _list->GetItemCount() > 0) {
176 _list->EnsureVisible (0);
178 SearchChanged (_search->GetValue().ToStdString());
181 void selection_changed ()
183 SelectionChanged (_list->selected_subtag());
186 wxSearchCtrl* _search;
187 SubtagListCtrl* _list;
191 FullLanguageTagDialog::FullLanguageTagDialog (wxWindow* parent, dcp::LanguageTag tag)
192 : wxDialog (parent, wxID_ANY, _("Language Tag"), wxDefaultPosition, wxSize(-1, 500))
194 _current_tag_list = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_SINGLE_SEL | wxLC_NO_HEADER);
195 _current_tag_list->AppendColumn ("", wxLIST_FORMAT_LEFT, 200);
196 _current_tag_list->AppendColumn ("", wxLIST_FORMAT_LEFT, 400);
198 auto button_sizer = new wxBoxSizer (wxVERTICAL);
199 _add_script = new wxButton(this, wxID_ANY, "Add script");
200 button_sizer->Add (_add_script, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
201 _add_region = new wxButton(this, wxID_ANY, "Add region");
202 button_sizer->Add (_add_region, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
203 _add_variant = new wxButton(this, wxID_ANY, "Add variant");
204 button_sizer->Add (_add_variant, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
205 _add_external = new wxButton(this, wxID_ANY, "Add external");
206 button_sizer->Add (_add_external, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
207 _remove = new wxButton(this, wxID_ANY, "Remove");
208 button_sizer->Add (_remove, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
210 _choose_subtag_panel = new LanguageSubtagPanel (this);
211 _choose_subtag_panel->set (dcp::LanguageTag::SubtagType::LANGUAGE, "");
213 auto ltor_sizer = new wxBoxSizer (wxHORIZONTAL);
214 ltor_sizer->Add (_current_tag_list, 1, wxALL, 8);
215 ltor_sizer->Add (button_sizer, 0, wxALL, 8);
216 ltor_sizer->Add (_choose_subtag_panel, 1, wxALL, 8);
218 auto overall_sizer = new wxBoxSizer (wxVERTICAL);
219 overall_sizer->Add (ltor_sizer, 0);
221 auto buttons = CreateSeparatedButtonSizer (wxOK);
223 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
226 SetSizerAndFit (overall_sizer);
230 _add_script->Bind (wxEVT_BUTTON, boost::bind(&FullLanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::SCRIPT, boost::optional<dcp::LanguageTag::SubtagData>()));
231 _add_region->Bind (wxEVT_BUTTON, boost::bind(&FullLanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::REGION, boost::optional<dcp::LanguageTag::SubtagData>()));
232 _add_variant->Bind (wxEVT_BUTTON, boost::bind(&FullLanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::VARIANT, boost::optional<dcp::LanguageTag::SubtagData>()));
233 _add_external->Bind (wxEVT_BUTTON, boost::bind(&FullLanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::EXTLANG, boost::optional<dcp::LanguageTag::SubtagData>()));
234 _remove->Bind (wxEVT_BUTTON, boost::bind(&FullLanguageTagDialog::remove_from_current_tag, this));
235 _choose_subtag_panel->SelectionChanged.connect(bind(&FullLanguageTagDialog::chosen_subtag_changed, this, _1));
236 _choose_subtag_panel->SearchChanged.connect(bind(&FullLanguageTagDialog::search_changed, this, _1));
237 _current_tag_list->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind(&FullLanguageTagDialog::current_tag_selection_changed, this));
238 _current_tag_list->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind(&FullLanguageTagDialog::current_tag_selection_changed, this));
243 FullLanguageTagDialog::remove_from_current_tag ()
245 auto selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
250 _current_tag_subtags.erase (_current_tag_subtags.begin() + selected);
251 _current_tag_list->DeleteItem (selected);
253 _current_tag_list->SetItemState (min(selected, _current_tag_list->GetItemCount() - 1L), wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
255 setup_sensitivity ();
256 current_tag_selection_changed ();
260 dcp::LanguageTag FullLanguageTagDialog::get () const
262 dcp::LanguageTag tag;
264 vector<dcp::LanguageTag::VariantSubtag> variants;
265 vector<dcp::LanguageTag::ExtlangSubtag> extlangs;
267 for (auto i: _current_tag_subtags) {
272 case dcp::LanguageTag::SubtagType::LANGUAGE:
273 tag.set_language (i.subtag->subtag);
275 case dcp::LanguageTag::SubtagType::SCRIPT:
276 tag.set_script (i.subtag->subtag);
278 case dcp::LanguageTag::SubtagType::REGION:
279 tag.set_region (i.subtag->subtag);
281 case dcp::LanguageTag::SubtagType::VARIANT:
282 variants.push_back (i.subtag->subtag);
284 case dcp::LanguageTag::SubtagType::EXTLANG:
285 extlangs.push_back (i.subtag->subtag);
290 tag.set_variants (variants);
291 tag.set_extlangs (extlangs);
297 FullLanguageTagDialog::set (dcp::LanguageTag tag)
299 _current_tag_subtags.clear ();
300 _current_tag_list->DeleteAllItems ();
302 bool have_language = false;
303 for (auto const& i: tag.subtags()) {
304 add_to_current_tag (i.first, i.second);
305 if (i.first == dcp::LanguageTag::SubtagType::LANGUAGE) {
306 have_language = true;
310 if (!have_language) {
311 add_to_current_tag (dcp::LanguageTag::SubtagType::LANGUAGE, dcp::LanguageTag::SubtagData("en", "English"));
316 string FullLanguageTagDialog::subtag_type_name (dcp::LanguageTag::SubtagType type)
319 case dcp::LanguageTag::SubtagType::LANGUAGE:
321 case dcp::LanguageTag::SubtagType::SCRIPT:
323 case dcp::LanguageTag::SubtagType::REGION:
325 case dcp::LanguageTag::SubtagType::VARIANT:
327 case dcp::LanguageTag::SubtagType::EXTLANG:
336 FullLanguageTagDialog::search_changed (string search)
338 long int selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
340 _current_tag_subtags[selected].last_search = search;
346 FullLanguageTagDialog::add_to_current_tag (dcp::LanguageTag::SubtagType type, optional<dcp::LanguageTag::SubtagData> subtag)
348 _current_tag_subtags.push_back (Subtag(type, subtag));
350 it.SetId (_current_tag_list->GetItemCount());
352 it.SetText (subtag_type_name(type));
353 _current_tag_list->InsertItem (it);
356 it.SetText (subtag->description);
358 it.SetText ("Select...");
360 _current_tag_list->SetItem (it);
361 _current_tag_list->SetItemState (_current_tag_list->GetItemCount() - 1, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
362 _choose_subtag_panel->set (type, "");
363 setup_sensitivity ();
364 current_tag_selection_changed ();
369 FullLanguageTagDialog::current_tag_selection_changed ()
371 auto selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
373 _choose_subtag_panel->Enable (true);
374 _choose_subtag_panel->set (_current_tag_subtags[selected].type, _current_tag_subtags[selected].last_search, _current_tag_subtags[selected].subtag);
376 _choose_subtag_panel->Enable (false);
382 FullLanguageTagDialog::chosen_subtag_changed (optional<dcp::LanguageTag::SubtagData> selection)
388 auto selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
390 _current_tag_subtags[selected].subtag = *selection;
391 _current_tag_list->SetItem (selected, 0, subtag_type_name(_current_tag_subtags[selected].type));
392 _current_tag_list->SetItem (selected, 1, selection->description);
395 setup_sensitivity ();
399 FullLanguageTagDialog::setup_sensitivity ()
401 _add_script->Enable ();
402 _add_region->Enable ();
403 _add_variant->Enable ();
404 _add_external->Enable ();
405 for (auto const& i: _current_tag_subtags) {
407 case dcp::LanguageTag::SubtagType::SCRIPT:
408 _add_script->Enable (false);
410 case dcp::LanguageTag::SubtagType::REGION:
411 _add_region->Enable (false);
413 case dcp::LanguageTag::SubtagType::VARIANT:
414 _add_variant->Enable (false);
416 case dcp::LanguageTag::SubtagType::EXTLANG:
417 _add_external->Enable (false);
423 auto selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
424 _remove->Enable (selected > 0);
428 RegionSubtagDialog::RegionSubtagDialog (wxWindow* parent, dcp::LanguageTag::RegionSubtag region)
429 : wxDialog (parent, wxID_ANY, _("Region"), wxDefaultPosition, wxSize(-1, 500))
430 , _panel (new LanguageSubtagPanel (this))
432 auto sizer = new wxBoxSizer (wxVERTICAL);
433 sizer->Add (_panel, 1);
435 auto buttons = CreateSeparatedButtonSizer (wxOK);
437 sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
442 _panel->set (dcp::LanguageTag::SubtagType::REGION, "", *dcp::LanguageTag::get_subtag_data(region));
446 optional<dcp::LanguageTag::RegionSubtag>
447 RegionSubtagDialog::get () const
449 return _panel->get ();