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 "lib/dcpomatic_assert.h"
23 #include "full_language_tag_dialog.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>
42 using boost::optional;
43 using std::shared_ptr;
45 #if BOOST_VERSION >= 106100
46 using namespace boost::placeholders;
50 class SubtagListCtrl : public wxListCtrl
53 SubtagListCtrl (wxWindow* parent)
54 : wxListCtrl (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_SINGLE_SEL | wxLC_NO_HEADER | wxLC_VIRTUAL)
56 AppendColumn ("", wxLIST_FORMAT_LEFT, 80);
57 AppendColumn ("", wxLIST_FORMAT_LEFT, 400);
60 void set (dcp::LanguageTag::SubtagType type, string search, optional<dcp::LanguageTag::SubtagData> subtag = optional<dcp::LanguageTag::SubtagData>())
62 _all_subtags = dcp::LanguageTag::get_all(type);
65 auto i = find(_matching_subtags.begin(), _matching_subtags.end(), *subtag);
66 if (i != _matching_subtags.end()) {
67 auto item = std::distance(_matching_subtags.begin(), i);
68 SetItemState (item, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
72 if (GetItemCount() > 0) {
73 /* The new list sometimes isn't visible without this */
79 void set_search (string search)
82 _matching_subtags = _all_subtags;
84 _matching_subtags.clear ();
86 boost::algorithm::to_lower(search);
87 for (auto const& i: _all_subtags) {
89 (boost::algorithm::to_lower_copy(i.subtag).find(search) != string::npos) ||
90 (boost::algorithm::to_lower_copy(i.description).find(search) != string::npos)) {
91 _matching_subtags.push_back (i);
96 SetItemCount (_matching_subtags.size());
97 if (GetItemCount() > 0) {
98 RefreshItems (0, GetItemCount() - 1);
102 optional<dcp::LanguageTag::SubtagData> selected_subtag () const
104 auto selected = GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
105 if (selected == -1) {
109 DCPOMATIC_ASSERT (static_cast<size_t>(selected) < _matching_subtags.size());
110 return _matching_subtags[selected];
114 wxString OnGetItemText (long item, long column) const
117 return _matching_subtags[item].subtag;
119 return _matching_subtags[item].description;
123 std::vector<dcp::LanguageTag::SubtagData> _all_subtags;
124 std::vector<dcp::LanguageTag::SubtagData> _matching_subtags;
128 class LanguageSubtagPanel : public wxPanel
131 LanguageSubtagPanel (wxWindow* parent)
132 : wxPanel (parent, wxID_ANY)
135 int const height = 30;
137 int const height = -1;
140 _search = new wxSearchCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(200, height));
141 _list = new SubtagListCtrl (this);
143 auto sizer = new wxBoxSizer (wxVERTICAL);
144 sizer->Add (_search, 0, wxALL, 8);
145 sizer->Add (_list, 1, wxALL, 8);
148 _search->Bind (wxEVT_TEXT, boost::bind(&LanguageSubtagPanel::search_changed, this));
149 _list->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind(&LanguageSubtagPanel::selection_changed, this));
150 _list->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind(&LanguageSubtagPanel::selection_changed, this));
153 void set (dcp::LanguageTag::SubtagType type, string search, optional<dcp::LanguageTag::SubtagData> subtag = optional<dcp::LanguageTag::SubtagData>())
155 _list->set (type, search, subtag);
156 _search->SetValue (wxString(search));
159 optional<dcp::LanguageTag::RegionSubtag> get () const
161 if (!_list->selected_subtag()) {
165 return dcp::LanguageTag::RegionSubtag(_list->selected_subtag()->subtag);
168 boost::signals2::signal<void (optional<dcp::LanguageTag::SubtagData>)> SelectionChanged;
169 boost::signals2::signal<void (string)> SearchChanged;
172 void search_changed ()
174 auto search = _search->GetValue();
175 _list->set_search (search.ToStdString());
176 if (search.Length() > 0) {
177 _list->EnsureVisible (0);
179 SearchChanged (_search->GetValue().ToStdString());
182 void selection_changed ()
184 SelectionChanged (_list->selected_subtag());
187 wxSearchCtrl* _search;
188 SubtagListCtrl* _list;
192 FullLanguageTagDialog::FullLanguageTagDialog (wxWindow* parent, dcp::LanguageTag tag)
193 : wxDialog (parent, wxID_ANY, "Language Tag", wxDefaultPosition, wxSize(-1, 500))
195 _current_tag_list = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_SINGLE_SEL | wxLC_NO_HEADER);
196 _current_tag_list->AppendColumn ("", wxLIST_FORMAT_LEFT, 200);
197 _current_tag_list->AppendColumn ("", wxLIST_FORMAT_LEFT, 400);
199 auto button_sizer = new wxBoxSizer (wxVERTICAL);
200 _add_script = new wxButton(this, wxID_ANY, "Add script");
201 button_sizer->Add (_add_script, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
202 _add_region = new wxButton(this, wxID_ANY, "Add region");
203 button_sizer->Add (_add_region, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
204 _add_variant = new wxButton(this, wxID_ANY, "Add variant");
205 button_sizer->Add (_add_variant, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
206 _add_external = new wxButton(this, wxID_ANY, "Add external");
207 button_sizer->Add (_add_external, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
208 _remove = new wxButton(this, wxID_ANY, "Remove");
209 button_sizer->Add (_remove, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
211 _choose_subtag_panel = new LanguageSubtagPanel (this);
212 _choose_subtag_panel->set (dcp::LanguageTag::SubtagType::LANGUAGE, "");
214 auto ltor_sizer = new wxBoxSizer (wxHORIZONTAL);
215 ltor_sizer->Add (_current_tag_list, 1, wxALL, 8);
216 ltor_sizer->Add (button_sizer, 0, wxALL, 8);
217 ltor_sizer->Add (_choose_subtag_panel, 1, wxALL, 8);
219 auto overall_sizer = new wxBoxSizer (wxVERTICAL);
220 overall_sizer->Add (ltor_sizer, 0);
222 auto buttons = CreateSeparatedButtonSizer (wxOK);
224 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
227 SetSizerAndFit (overall_sizer);
231 _add_script->Bind (wxEVT_BUTTON, boost::bind(&FullLanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::SCRIPT, boost::optional<dcp::LanguageTag::SubtagData>()));
232 _add_region->Bind (wxEVT_BUTTON, boost::bind(&FullLanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::REGION, boost::optional<dcp::LanguageTag::SubtagData>()));
233 _add_variant->Bind (wxEVT_BUTTON, boost::bind(&FullLanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::VARIANT, boost::optional<dcp::LanguageTag::SubtagData>()));
234 _add_external->Bind (wxEVT_BUTTON, boost::bind(&FullLanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::EXTLANG, boost::optional<dcp::LanguageTag::SubtagData>()));
235 _remove->Bind (wxEVT_BUTTON, boost::bind(&FullLanguageTagDialog::remove_from_current_tag, this));
236 _choose_subtag_panel->SelectionChanged.connect(bind(&FullLanguageTagDialog::chosen_subtag_changed, this, _1));
237 _choose_subtag_panel->SearchChanged.connect(bind(&FullLanguageTagDialog::search_changed, this, _1));
238 _current_tag_list->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind(&FullLanguageTagDialog::current_tag_selection_changed, this));
239 _current_tag_list->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind(&FullLanguageTagDialog::current_tag_selection_changed, this));
244 FullLanguageTagDialog::remove_from_current_tag ()
246 auto selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
251 _current_tag_subtags.erase (_current_tag_subtags.begin() + selected);
252 _current_tag_list->DeleteItem (selected);
254 _current_tag_list->SetItemState (min(selected, _current_tag_list->GetItemCount() - 1L), wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
256 setup_sensitivity ();
257 current_tag_selection_changed ();
261 dcp::LanguageTag FullLanguageTagDialog::get () const
263 dcp::LanguageTag tag;
265 vector<dcp::LanguageTag::VariantSubtag> variants;
266 vector<dcp::LanguageTag::ExtlangSubtag> extlangs;
268 for (auto i: _current_tag_subtags) {
273 case dcp::LanguageTag::SubtagType::LANGUAGE:
274 tag.set_language (i.subtag->subtag);
276 case dcp::LanguageTag::SubtagType::SCRIPT:
277 tag.set_script (i.subtag->subtag);
279 case dcp::LanguageTag::SubtagType::REGION:
280 tag.set_region (i.subtag->subtag);
282 case dcp::LanguageTag::SubtagType::VARIANT:
283 variants.push_back (i.subtag->subtag);
285 case dcp::LanguageTag::SubtagType::EXTLANG:
286 extlangs.push_back (i.subtag->subtag);
291 tag.set_variants (variants);
292 tag.set_extlangs (extlangs);
298 FullLanguageTagDialog::set (dcp::LanguageTag tag)
300 _current_tag_subtags.clear ();
301 _current_tag_list->DeleteAllItems ();
303 bool have_language = false;
304 for (auto const& i: tag.subtags()) {
305 add_to_current_tag (i.first, i.second);
306 if (i.first == dcp::LanguageTag::SubtagType::LANGUAGE) {
307 have_language = true;
311 if (!have_language) {
312 add_to_current_tag (dcp::LanguageTag::SubtagType::LANGUAGE, dcp::LanguageTag::SubtagData("en", "English"));
317 string FullLanguageTagDialog::subtag_type_name (dcp::LanguageTag::SubtagType type)
320 case dcp::LanguageTag::SubtagType::LANGUAGE:
322 case dcp::LanguageTag::SubtagType::SCRIPT:
324 case dcp::LanguageTag::SubtagType::REGION:
326 case dcp::LanguageTag::SubtagType::VARIANT:
328 case dcp::LanguageTag::SubtagType::EXTLANG:
337 FullLanguageTagDialog::search_changed (string search)
339 long int selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
341 _current_tag_subtags[selected].last_search = search;
347 FullLanguageTagDialog::add_to_current_tag (dcp::LanguageTag::SubtagType type, optional<dcp::LanguageTag::SubtagData> subtag)
349 _current_tag_subtags.push_back (Subtag(type, subtag));
351 it.SetId (_current_tag_list->GetItemCount());
353 it.SetText (subtag_type_name(type));
354 _current_tag_list->InsertItem (it);
357 it.SetText (subtag->description);
359 it.SetText ("Select...");
361 _current_tag_list->SetItem (it);
362 _current_tag_list->SetItemState (_current_tag_list->GetItemCount() - 1, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
363 _choose_subtag_panel->set (type, "");
364 setup_sensitivity ();
365 current_tag_selection_changed ();
370 FullLanguageTagDialog::current_tag_selection_changed ()
372 auto selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
374 _choose_subtag_panel->Enable (true);
375 _choose_subtag_panel->set (_current_tag_subtags[selected].type, _current_tag_subtags[selected].last_search, _current_tag_subtags[selected].subtag);
377 _choose_subtag_panel->Enable (false);
383 FullLanguageTagDialog::chosen_subtag_changed (optional<dcp::LanguageTag::SubtagData> selection)
389 auto selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
391 _current_tag_subtags[selected].subtag = *selection;
392 _current_tag_list->SetItem (selected, 0, subtag_type_name(_current_tag_subtags[selected].type));
393 _current_tag_list->SetItem (selected, 1, selection->description);
396 setup_sensitivity ();
400 FullLanguageTagDialog::setup_sensitivity ()
402 _add_script->Enable ();
403 _add_region->Enable ();
404 _add_variant->Enable ();
405 _add_external->Enable ();
406 for (auto const& i: _current_tag_subtags) {
408 case dcp::LanguageTag::SubtagType::SCRIPT:
409 _add_script->Enable (false);
411 case dcp::LanguageTag::SubtagType::REGION:
412 _add_region->Enable (false);
414 case dcp::LanguageTag::SubtagType::VARIANT:
415 _add_variant->Enable (false);
417 case dcp::LanguageTag::SubtagType::EXTLANG:
418 _add_external->Enable (false);
424 auto selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
425 _remove->Enable (selected > 0);
429 RegionSubtagDialog::RegionSubtagDialog (wxWindow* parent, dcp::LanguageTag::RegionSubtag region)
430 : wxDialog (parent, wxID_ANY, _("Region"), wxDefaultPosition, wxSize(-1, 500))
431 , _panel (new LanguageSubtagPanel (this))
433 auto sizer = new wxBoxSizer (wxVERTICAL);
434 sizer->Add (_panel, 1);
436 auto buttons = CreateSeparatedButtonSizer (wxOK);
438 sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
443 _panel->set (dcp::LanguageTag::SubtagType::REGION, "", *dcp::LanguageTag::get_subtag_data(region));
447 optional<dcp::LanguageTag::RegionSubtag>
448 RegionSubtagDialog::get () const
450 return _panel->get ();