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