MagicSetEditor2/src/gui/control/keyword_list.cpp

//+----------------------------------------------------------------------------+
//| Description:  Magic Set Editor - Program to make card games                |
//| Copyright:    (C) Twan van Laarhoven and the other MSE developers          |
//| License:      GNU General Public License 2 or later (see file COPYING)     |
//+----------------------------------------------------------------------------+

// ----------------------------------------------------------------------------- : Includes

#include <util/prec.hpp>
#include <gui/control/keyword_list.hpp>
#include <gui/util.hpp>
#include <data/set.hpp>
#include <data/game.hpp>
#include <data/card.hpp>
#include <data/keyword.hpp>
#include <data/action/value.hpp>
#include <data/action/keyword.hpp>
#include <data/format/clipboard.hpp>
#include <util/tagged_string.hpp>
#include <util/window_id.hpp>
#include <gfx/color.hpp>
#include <wx/clipbrd.h>

// ----------------------------------------------------------------------------- : Events

DEFINE_EVENT_TYPE(EVENT_KEYWORD_SELECT);

// ----------------------------------------------------------------------------- : KeywordList

KeywordList::KeywordList(Window* parent, int id, long additional_style)
  : ItemList(parent, id, additional_style)
{
  // Add columns
  InsertColumn(0, _LABEL_("keyword"),  wxLIST_FORMAT_LEFT,    0);
  InsertColumn(1, _LABEL_("match"),    wxLIST_FORMAT_LEFT,  200);
  InsertColumn(2, _LABEL_("mode"),     wxLIST_FORMAT_LEFT,   60);
  InsertColumn(3, _LABEL_("uses"),     wxLIST_FORMAT_RIGHT,  50);
  InsertColumn(4, _LABEL_("reminder"), wxLIST_FORMAT_LEFT,  300);
}

KeywordList::~KeywordList() {
  storeColumns();
}
void KeywordList::storeColumns() {
  // TODO
}

void KeywordList::onBeforeChangeSet() {
  storeColumns();
}
void KeywordList::onChangeSet() {
  updateUsageStatistics();
  refreshList();
}

void KeywordList::setFilter(const KeywordListFilterP& filter) {

  this->filter = filter;
  refreshList();
}

void KeywordList::onAction(const Action& action, bool undone) {
  TYPE_CASE(action, AddKeywordAction) {
    if (action.action.adding != undone) {
      // select the new keyword
      selectItem(action.action.steps[0].item, false /*list will be refreshed anyway*/, true);
      refreshList();
    } else {
      long pos = selected_item_pos;
      refreshList();
      if (selected_item_pos == -1) {
        // selected keyword was deleted, select the next
        selectItemPos(pos, true);
      }
    }
  }
  TYPE_CASE(action, ValueAction) {
    if (!action.card) {
      KeywordTextValue* value = dynamic_cast<KeywordTextValue*>(action.valueP.get());
      if (value) {
        // this is indeed an action on a keyword, refresh
        refreshList(true);
      }
    }
  }
  TYPE_CASE_(action, ChangeKeywordModeAction) {
    refreshList();
  }
}

void KeywordList::updateUsageStatistics() {
  usage_statistics.clear();
  FOR_EACH_CONST(card, set->cards) {
    for (KeywordUsageStatistics::const_iterator it = card->keyword_usage.begin() ; it != card->keyword_usage.end() ; ++it) {
      usage_statistics[it->second]++;
    }
  }
}

// ----------------------------------------------------------------------------- : Clipboard

bool KeywordList::canDelete() const { return !getKeyword()->fixed; }
bool KeywordList::canCopy()   const { return !!selected_item; }
bool KeywordList::canPaste()  const {
  return wxTheClipboard->IsSupported(KeywordDataObject::format);
}

bool KeywordList::doCopy() {
  if (!canCopy()) return false;
  if (!wxTheClipboard->Open()) return false;
  bool ok = wxTheClipboard->SetData(new KeywordDataObject(set, getKeyword())); // ignore result
  wxTheClipboard->Flush();
  wxTheClipboard->Close();
  return ok;
}
bool KeywordList::doCut() {
  // cut = copy + delete
  if (!canCut()) return false;
  if (!doCopy()) return false;
  doDelete();
  return true;
}
bool KeywordList::doPaste() {
  // get data
  if (!canPaste()) return false;
  if (!wxTheClipboard->Open()) return false;
  KeywordDataObject data;
  bool ok = wxTheClipboard->GetData(data);
  wxTheClipboard->Flush();
  wxTheClipboard->Close();
  if (!ok) return false;
  // add keyword to set
  KeywordP keyword = data.getKeyword(set);
  if (keyword) {
    set->actions.addAction(make_unique<AddKeywordAction>(ADD, *set, keyword));
    return true;
  } else {
    return false;
  }
}
bool KeywordList::doDelete() {
  set->actions.addAction(make_unique<AddKeywordAction>(REMOVE, *set, getKeyword()));
  return true;
}

// ----------------------------------------------------------------------------- : KeywordListBase : for ItemList

String match_string(const Keyword& a) {
  return untag(replace_all(replace_all(
              a.match,
             _("<atom-param>"), LEFT_ANGLE_BRACKET),
            _("</atom-param>"), RIGHT_ANGLE_BRACKET)
         );
}

void KeywordList::getItems(vector<VoidP>& out) const {
  FOR_EACH(k, set->keywords) {
    k->fixed = false;
    if (!filter || filter->keep(*k)) {
      out.push_back(k);
    }
  }
  FOR_EACH(k, set->game->keywords) {
    k->fixed = true;
    if (!filter || filter->keep(*k)) {
      out.push_back(k);
    }
  }
}
void KeywordList::sendEvent() {
  KeywordSelectEvent ev(getKeyword());
  ProcessEvent(ev);
}
bool KeywordList::compareItems(void* a, void* b) const {
  const Keyword& ka = *(Keyword*)a;
  const Keyword& kb = *(Keyword*)b;
  switch(sort_by_column) {
    case 0:  return ka.keyword < kb.keyword;
    case 1: return ka.match   < kb.match;
    case 2: return ka.mode    < kb.mode;
    case 3: return usage(ka)  < usage(kb);
    case 4: return ka.reminder.getUnparsed() < kb.reminder.getUnparsed();
    default: // TODO: 3
        return ka.keyword < kb.keyword;
  }
}

int KeywordList::usage(const Keyword& kw) const {
  map<const Keyword*,int>::const_iterator it = usage_statistics.find(&kw);
  if (it == usage_statistics.end()) return 0;
  else return it->second;
}

// ----------------------------------------------------------------------------- : KeywordList : Item text

String KeywordList::OnGetItemText (long pos, long col) const {
  if (sorted_list.size() == 0) return _("");
  
  const Keyword& kw = *getKeyword(pos);
  switch(col) {
    case 0:    return kw.keyword;
    case 1:    return match_string(kw);
    case 2:    return kw.mode;
    case 3:    return String::Format(_("%d"), usage(kw));
    case 4: {
      // convert all whitespace to ' '
      String formatted;
      bool seen_space = false;
      for (size_t i = 0; i < kw.reminder.getUnparsed().size(); ++i) {
        Char c = kw.reminder.getUnparsed().GetChar(i);
        if (isSpace(c)) {
          seen_space = true;
        } else {
          if (seen_space) {
            formatted += _(' ');
            seen_space = false;
          }
          formatted += c;
        }
      }
      return formatted;
    }
    default:  return _("");
  }
}
int KeywordList::OnGetItemImage(long pos) const {
  return -1;
}

wxListItemAttr* KeywordList::OnGetItemAttr(long pos) const {
  if (sorted_list.size() == 0) return nullptr;
  // black for set keywords, grey for game keywords (uneditable)
  const Keyword& kw = *getKeyword(pos);
  if (!kw.fixed && kw.valid) return nullptr;
  if (!kw.valid) {
    item_attr.SetTextColour(*wxRED);
  } else if (kw.fixed) {
    item_attr.SetTextColour(lerp(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW),wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT),0.5));
  }
  return &item_attr;
}

// ----------------------------------------------------------------------------- : KeywordList : Context menu

void KeywordList::onContextMenu(wxContextMenuEvent&) {
  wxMenu m;
  add_menu_item_tr(&m, ID_EDIT_CUT, settings.darkModePrefix() + "cut", "cut_keyword");
  add_menu_item_tr(&m, ID_EDIT_COPY, "copy", "copy_keyword");
  add_menu_item_tr(&m, ID_EDIT_PASTE, "paste", "paste_keyword");
  m.AppendSeparator();
  add_menu_item_tr(&m, ID_KEYWORD_ADD, "keyword_add", "add_keyword");
  add_menu_item_tr(&m, ID_KEYWORD_REMOVE, "keyword_del", "remove_keyword");
  PopupMenu(&m);
}

BEGIN_EVENT_TABLE(KeywordList, ItemList)
  EVT_CONTEXT_MENU(KeywordList::onContextMenu)
END_EVENT_TABLE  ()