src/wx/language_tag_dialog.cc

   1 /*
   2     Copyright (C) 2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21
  22 #include "lib/dcpomatic_assert.h"
  23 #include "language_tag_dialog.h"
  24 #include <dcp/language_tag.h>
  25 #include <wx/listctrl.h>
  26 #include <wx/srchctrl.h>
  27 #include <wx/wx.h>
  28 #include <boost/algorithm/string.hpp>
  29 #include <boost/bind/bind.hpp>
  30 #include <boost/optional.hpp>
  31 #include <boost/signals2.hpp>
  32 #include <iostream>
  33 #include <iterator>
  34 #include <string>
  35 #include <vector>
  36
  37
  38 using std::min;
  39 using std::pair;
  40 using std::string;
  41 using std::vector;
  42 using boost::optional;
  43 using std::shared_ptr;
  44 using std::weak_ptr;
  45 #if BOOST_VERSION >= 106100
  46 using namespace boost::placeholders;
  47 #endif
  48
  49
  50 class SubtagListCtrl : public wxListCtrl
  51 {
  52 public:
  53         SubtagListCtrl (wxWindow* parent)
  54                 : wxListCtrl (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_SINGLE_SEL | wxLC_NO_HEADER | wxLC_VIRTUAL)
  55         {
  56                 AppendColumn ("", wxLIST_FORMAT_LEFT, 80);
  57                 AppendColumn ("", wxLIST_FORMAT_LEFT, 400);
  58         }
  59
  60         void set (dcp::LanguageTag::SubtagType type, string search, optional<dcp::LanguageTag::SubtagData> subtag = optional<dcp::LanguageTag::SubtagData>())
  61         {
  62                 _all_subtags = dcp::LanguageTag::get_all(type);
  63                 set_search (search);
  64                 if (subtag) {
  65                         vector<dcp::LanguageTag::SubtagData>::iterator i = find(_matching_subtags.begin(), _matching_subtags.end(), *subtag);
  66                         if (i != _matching_subtags.end()) {
  67                                 long item = std::distance(_matching_subtags.begin(), i);
  68                                 SetItemState (item, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
  69                                 EnsureVisible (item);
  70                         }
  71                 } else {
  72                         if (GetItemCount() > 0) {
  73                                 /* The new list sometimes isn't visible without this */
  74                                 EnsureVisible (0);
  75                         }
  76                 }
  77         }
  78
  79         void set_search (string search)
  80         {
  81                 if (search == "") {
  82                         _matching_subtags = _all_subtags;
  83                 } else {
  84                         _matching_subtags.clear ();
  85
  86                         boost::algorithm::to_lower(search);
  87                         for (auto const& i: _all_subtags) {
  88                                 if (
  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);
  92                                 }
  93                         }
  94                 }
  95
  96                 SetItemCount (_matching_subtags.size());
  97                 if (GetItemCount() > 0) {
  98                         RefreshItems (0, GetItemCount() - 1);
  99                 }
 100         }
 101
 102         optional<dcp::LanguageTag::SubtagData> selected_subtag () const
 103         {
 104                 long int selected = GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 105                 if (selected == -1) {
 106                         return optional<dcp::LanguageTag::SubtagData>();
 107                 }
 108
 109                 DCPOMATIC_ASSERT (static_cast<size_t>(selected) < _matching_subtags.size());
 110                 return _matching_subtags[selected];
 111         }
 112
 113 private:
 114         wxString OnGetItemText (long item, long column) const
 115         {
 116                 if (column == 0) {
 117                         return _matching_subtags[item].subtag;
 118                 } else {
 119                         return _matching_subtags[item].description;
 120                 }
 121         }
 122
 123         std::vector<dcp::LanguageTag::SubtagData> _all_subtags;
 124         std::vector<dcp::LanguageTag::SubtagData> _matching_subtags;
 125 };
 126
 127
 128 class LanguageSubtagPanel : public wxPanel
 129 {
 130 public:
 131         LanguageSubtagPanel (wxWindow* parent)
 132                 : wxPanel (parent, wxID_ANY)
 133         {
 134 #ifdef __WXGTK3__
 135                 int const height = 30;
 136 #else
 137                 int const height = -1;
 138 #endif
 139
 140                 _search = new wxSearchCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(200, height));
 141                 _list = new SubtagListCtrl (this);
 142
 143                 wxBoxSizer* sizer = new wxBoxSizer (wxVERTICAL);
 144                 sizer->Add (_search, 0, wxALL, 8);
 145                 sizer->Add (_list, 1, wxALL, 8);
 146                 SetSizer (sizer);
 147
 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));
 151         }
 152
 153         void set (dcp::LanguageTag::SubtagType type, string search, optional<dcp::LanguageTag::SubtagData> subtag = optional<dcp::LanguageTag::SubtagData>())
 154         {
 155                 _list->set (type, search, subtag);
 156                 _search->SetValue (wxString(search));
 157         }
 158
 159         optional<dcp::LanguageTag::RegionSubtag> get () const
 160         {
 161                 if (!_list->selected_subtag()) {
 162                         return optional<dcp::LanguageTag::RegionSubtag>();
 163                 }
 164
 165                 return dcp::LanguageTag::RegionSubtag(_list->selected_subtag()->subtag);
 166         }
 167
 168         boost::signals2::signal<void (optional<dcp::LanguageTag::SubtagData>)> SelectionChanged;
 169         boost::signals2::signal<void (string)> SearchChanged;
 170
 171 private:
 172         void search_changed ()
 173         {
 174                 _list->set_search (_search->GetValue().ToStdString());
 175                 SearchChanged (_search->GetValue().ToStdString());
 176         }
 177
 178         void selection_changed ()
 179         {
 180                 SelectionChanged (_list->selected_subtag());
 181         }
 182
 183         wxSearchCtrl* _search;
 184         SubtagListCtrl* _list;
 185 };
 186
 187
 188 LanguageTagDialog::LanguageTagDialog (wxWindow* parent, dcp::LanguageTag tag)
 189         : wxDialog (parent, wxID_ANY, "Language Tag", wxDefaultPosition, wxSize(-1, 500))
 190 {
 191         _current_tag_list = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLC_REPORT | wxLC_SINGLE_SEL | wxLC_NO_HEADER);
 192         _current_tag_list->AppendColumn ("", wxLIST_FORMAT_LEFT, 200);
 193         _current_tag_list->AppendColumn ("", wxLIST_FORMAT_LEFT, 400);
 194
 195         wxBoxSizer* button_sizer = new wxBoxSizer (wxVERTICAL);
 196         _add_script = new wxButton(this, wxID_ANY, "Add script");
 197         button_sizer->Add (_add_script, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
 198         _add_region = new wxButton(this, wxID_ANY, "Add region");
 199         button_sizer->Add (_add_region, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
 200         _add_variant = new wxButton(this, wxID_ANY, "Add variant");
 201         button_sizer->Add (_add_variant, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
 202         _add_external = new wxButton(this, wxID_ANY, "Add external");
 203         button_sizer->Add (_add_external, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
 204         _remove = new wxButton(this, wxID_ANY, "Remove");
 205         button_sizer->Add (_remove, 0, wxTOP | wxBOTTOM | wxEXPAND, 2);
 206
 207         _choose_subtag_panel = new LanguageSubtagPanel (this);
 208         _choose_subtag_panel->set (dcp::LanguageTag::SubtagType::LANGUAGE, "");
 209
 210         wxBoxSizer* ltor_sizer = new wxBoxSizer (wxHORIZONTAL);
 211         ltor_sizer->Add (_current_tag_list, 1, wxALL, 8);
 212         ltor_sizer->Add (button_sizer, 0, wxALL, 8);
 213         ltor_sizer->Add (_choose_subtag_panel, 1, wxALL, 8);
 214
 215         wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
 216         overall_sizer->Add (ltor_sizer, 0);
 217
 218         wxSizer* buttons = CreateSeparatedButtonSizer (wxOK);
 219         if (buttons) {
 220                 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
 221         }
 222
 223         SetSizerAndFit (overall_sizer);
 224
 225         set (tag);
 226
 227         _add_script->Bind (wxEVT_BUTTON, boost::bind(&LanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::SCRIPT, boost::optional<dcp::LanguageTag::SubtagData>()));
 228         _add_region->Bind (wxEVT_BUTTON, boost::bind(&LanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::REGION, boost::optional<dcp::LanguageTag::SubtagData>()));
 229         _add_variant->Bind (wxEVT_BUTTON, boost::bind(&LanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::VARIANT, boost::optional<dcp::LanguageTag::SubtagData>()));
 230         _add_external->Bind (wxEVT_BUTTON, boost::bind(&LanguageTagDialog::add_to_current_tag, this, dcp::LanguageTag::SubtagType::EXTLANG, boost::optional<dcp::LanguageTag::SubtagData>()));
 231         _remove->Bind (wxEVT_BUTTON, boost::bind(&LanguageTagDialog::remove_from_current_tag, this));
 232         _choose_subtag_panel->SelectionChanged.connect(bind(&LanguageTagDialog::chosen_subtag_changed, this, _1));
 233         _choose_subtag_panel->SearchChanged.connect(bind(&LanguageTagDialog::search_changed, this, _1));
 234         _current_tag_list->Bind (wxEVT_LIST_ITEM_SELECTED, boost::bind(&LanguageTagDialog::current_tag_selection_changed, this));
 235         _current_tag_list->Bind (wxEVT_LIST_ITEM_DESELECTED, boost::bind(&LanguageTagDialog::current_tag_selection_changed, this));
 236 }
 237
 238
 239 void
 240 LanguageTagDialog::remove_from_current_tag ()
 241 {
 242         long int selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 243         if (selected <= 0) {
 244                 return;
 245         }
 246
 247         _current_tag_subtags.erase (_current_tag_subtags.begin() + selected);
 248         _current_tag_list->DeleteItem (selected);
 249
 250         _current_tag_list->SetItemState (min(selected, _current_tag_list->GetItemCount() - 1L), wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
 251
 252         setup_sensitivity ();
 253         current_tag_selection_changed ();
 254 }
 255
 256
 257 dcp::LanguageTag LanguageTagDialog::get () const
 258 {
 259         dcp::LanguageTag tag;
 260
 261         vector<dcp::LanguageTag::VariantSubtag> variants;
 262         vector<dcp::LanguageTag::ExtlangSubtag> extlangs;
 263
 264         for (auto i: _current_tag_subtags) {
 265                 if (!i.subtag) {
 266                         continue;
 267                 }
 268                 switch (i.type) {
 269                         case dcp::LanguageTag::SubtagType::LANGUAGE:
 270                                 tag.set_language (i.subtag->subtag);
 271                                 break;
 272                         case dcp::LanguageTag::SubtagType::SCRIPT:
 273                                 tag.set_script (i.subtag->subtag);
 274                                 break;
 275                         case dcp::LanguageTag::SubtagType::REGION:
 276                                 tag.set_region (i.subtag->subtag);
 277                                 break;
 278                         case dcp::LanguageTag::SubtagType::VARIANT:
 279                                 variants.push_back (i.subtag->subtag);
 280                                 break;
 281                         case dcp::LanguageTag::SubtagType::EXTLANG:
 282                                 extlangs.push_back (i.subtag->subtag);
 283                                 break;
 284                 }
 285         }
 286
 287         tag.set_variants (variants);
 288         tag.set_extlangs (extlangs);
 289         return tag;
 290 }
 291
 292
 293 void
 294 LanguageTagDialog::set (dcp::LanguageTag tag)
 295 {
 296         _current_tag_subtags.clear ();
 297         _current_tag_list->DeleteAllItems ();
 298
 299         bool have_language = false;
 300         for (auto const& i: tag.subtags()) {
 301                 add_to_current_tag (i.first, i.second);
 302                 if (i.first == dcp::LanguageTag::SubtagType::LANGUAGE) {
 303                         have_language = true;
 304                 }
 305         }
 306
 307         if (!have_language) {
 308                 add_to_current_tag (dcp::LanguageTag::SubtagType::LANGUAGE, dcp::LanguageTag::SubtagData("en", "English"));
 309         }
 310 }
 311
 312
 313 string LanguageTagDialog::subtag_type_name (dcp::LanguageTag::SubtagType type)
 314 {
 315         switch (type) {
 316                 case dcp::LanguageTag::SubtagType::LANGUAGE:
 317                         return "Language";
 318                 case dcp::LanguageTag::SubtagType::SCRIPT:
 319                         return "Script";
 320                 case dcp::LanguageTag::SubtagType::REGION:
 321                         return "Region";
 322                 case dcp::LanguageTag::SubtagType::VARIANT:
 323                         return "Variant";
 324                 case dcp::LanguageTag::SubtagType::EXTLANG:
 325                         return "External";
 326         }
 327
 328         return "";
 329 }
 330
 331
 332 void
 333 LanguageTagDialog::search_changed (string search)
 334 {
 335         long int selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 336         if (selected >= 0) {
 337                 _current_tag_subtags[selected].last_search = search;
 338         }
 339 }
 340
 341
 342 void
 343 LanguageTagDialog::add_to_current_tag (dcp::LanguageTag::SubtagType type, optional<dcp::LanguageTag::SubtagData> subtag)
 344 {
 345         _current_tag_subtags.push_back (Subtag(type, subtag));
 346         wxListItem it;
 347         it.SetId (_current_tag_list->GetItemCount());
 348         it.SetColumn (0);
 349         it.SetText (subtag_type_name(type));
 350         _current_tag_list->InsertItem (it);
 351         it.SetColumn (1);
 352         if (subtag) {
 353                 it.SetText (subtag->description);
 354         } else {
 355                 it.SetText ("Select...");
 356         }
 357         _current_tag_list->SetItem (it);
 358         _current_tag_list->SetItemState (_current_tag_list->GetItemCount() - 1, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
 359         _choose_subtag_panel->set (type, "");
 360         setup_sensitivity ();
 361         current_tag_selection_changed ();
 362 }
 363
 364
 365 void
 366 LanguageTagDialog::current_tag_selection_changed ()
 367 {
 368         long int selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 369         if (selected >= 0) {
 370                 _choose_subtag_panel->Enable (true);
 371                 _choose_subtag_panel->set (_current_tag_subtags[selected].type, _current_tag_subtags[selected].last_search, _current_tag_subtags[selected].subtag);
 372         } else {
 373                 _choose_subtag_panel->Enable (false);
 374         }
 375 }
 376
 377
 378 void
 379 LanguageTagDialog::chosen_subtag_changed (optional<dcp::LanguageTag::SubtagData> selection)
 380 {
 381         if (!selection) {
 382                 return;
 383         }
 384
 385         long int selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 386         if (selected >= 0) {
 387                 _current_tag_subtags[selected].subtag = *selection;
 388                 _current_tag_list->SetItem (selected, 0, subtag_type_name(_current_tag_subtags[selected].type));
 389                 _current_tag_list->SetItem (selected, 1, selection->description);
 390         }
 391
 392         setup_sensitivity ();
 393 }
 394
 395 void
 396 LanguageTagDialog::setup_sensitivity ()
 397 {
 398         _add_script->Enable ();
 399         _add_region->Enable ();
 400         _add_variant->Enable ();
 401         _add_external->Enable ();
 402         for (auto const& i: _current_tag_subtags) {
 403                 switch (i.type) {
 404                         case dcp::LanguageTag::SubtagType::SCRIPT:
 405                                 _add_script->Enable (false);
 406                                 break;
 407                         case dcp::LanguageTag::SubtagType::REGION:
 408                                 _add_region->Enable (false);
 409                                 break;
 410                         case dcp::LanguageTag::SubtagType::VARIANT:
 411                                 _add_variant->Enable (false);
 412                                 break;
 413                         case dcp::LanguageTag::SubtagType::EXTLANG:
 414                                 _add_external->Enable (false);
 415                                 break;
 416                         default:
 417                                 break;
 418                 }
 419         }
 420         long int selected = _current_tag_list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 421         _remove->Enable (selected > 0);
 422 }
 423
 424
 425 RegionSubtagDialog::RegionSubtagDialog (wxWindow* parent, dcp::LanguageTag::RegionSubtag region)
 426         : wxDialog (parent, wxID_ANY, _("Region"), wxDefaultPosition, wxSize(-1, 500))
 427         , _panel (new LanguageSubtagPanel (this))
 428 {
 429         wxBoxSizer* sizer = new wxBoxSizer (wxVERTICAL);
 430         sizer->Add (_panel, 1);
 431
 432         wxSizer* buttons = CreateSeparatedButtonSizer (wxOK);
 433         if (buttons) {
 434                 sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
 435         }
 436
 437         SetSizer (sizer);
 438
 439         _panel->set (dcp::LanguageTag::SubtagType::REGION, "", *dcp::LanguageTag::get_subtag_data(region));
 440 }
 441
 442
 443 optional<dcp::LanguageTag::RegionSubtag>
 444 RegionSubtagDialog::get () const
 445 {
 446         return _panel->get ();
 447 }
 448
 449