Files
MagicSetEditor2/src/gui/control/card_list.cpp
T

695 lines
23 KiB
C++

//+----------------------------------------------------------------------------+
//| Description: Magic Set Editor - Program to make Magic (tm) cards |
//| 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 <util/uid.hpp>
#include <gui/control/card_list.hpp>
#include <gui/control/card_list_column_select.hpp>
#include <gui/set/window.hpp> // for sorting all cardlists in a window
#include <gui/card_link_window.hpp>
#include <gui/web_request_window.hpp>
#include <gui/util.hpp>
#include <gui/add_csv_window.hpp>
#include <gui/add_json_window.hpp>
#include <gui/bulk_modification_window.hpp>
#include <data/game.hpp>
#include <data/field.hpp>
#include <data/field/choice.hpp>
#include <data/set.hpp>
#include <data/card.hpp>
#include <data/settings.hpp>
#include <data/stylesheet.hpp>
#include <data/format/clipboard.hpp>
#include <data/format/formats.hpp>
#include <data/action/set.hpp>
#include <data/action/value.hpp>
#include <script/functions/json.hpp>
#include <util/window_id.hpp>
#include <wx/clipbrd.h>
#include <wx/webrequest.h>
#include <wx/wfstream.h>
#include <unordered_set>
#include <fstream>
DECLARE_POINTER_TYPE(ChoiceValue);
// ----------------------------------------------------------------------------- : Events
DEFINE_EVENT_TYPE(EVENT_CARD_SELECT);
DEFINE_EVENT_TYPE(EVENT_CARD_ACTIVATE);
CardP CardSelectEvent::getCard() const {
return getTheCardList()->getCard();
}
void CardSelectEvent::getSelection(vector<CardP>& out) const {
getTheCardList()->getSelection(out);
}
CardListBase* CardSelectEvent::getTheCardList() const {
return static_cast<CardListBase*>(GetEventObject());
}
// ----------------------------------------------------------------------------- : CardListBase
CardListBase::CardListBase(Window* parent, int id, long additional_style)
: ItemList(parent, id, additional_style, true)
{
drop_target = new CardListDropTarget(this);
}
CardListBase::~CardListBase() {
storeColumns();
}
void CardListBase::onBeforeChangeSet() {
storeColumns();
}
void CardListBase::onChangeSet() {
rebuild();
}
struct Freezer{
Window* window;
Freezer(Window* window) : window(window) { window->Freeze(); }
~Freezer() { window->Thaw(); }
};
void CardListBase::onAction(const Action& action, bool undone) {
TYPE_CASE(action, AddCardAction) {
Freezer freeze(this);
if (action.action.adding != undone) {
// select the new cards
focusNone();
selectItem(action.action.steps.front().item, false, true);
refreshList();
FOR_EACH_CONST(s, action.action.steps) focusItem(s.item); // focus all the new cards
} else {
long pos = selected_item_pos;
// adjust focus for all the removed cards
refreshList();
if (!allowModify()) {
// Let some other card list do the selecting, otherwise we get conflicting events
return;
}
if (selected_item_pos == -1) {
// selected item was deleted, select something else
selectItemPos(pos, true, true);
}
}
}
TYPE_CASE(action, ReorderCardsAction) {
if (sort_by_column >= 0) return; // nothing changes for us
if ((long)action.card_id1 < 0 || (long)action.card_id2 >= (long)sorted_list.size()) return;
if ((long)action.card_id1 == selected_item_pos || (long)action.card_id2 == selected_item_pos) {
// Selected card has moved; also move in the sorted card list
swap(sorted_list[action.card_id1], sorted_list[action.card_id2]);
// reselect the current card, it has moved
selected_item_pos = (long)action.card_id1 == selected_item_pos ? (long)action.card_id2 : (long)action.card_id1;
// select the right card
focusSelectedItem();
}
RefreshItem((long)action.card_id1);
RefreshItem((long)action.card_id2);
}
TYPE_CASE_(action, ScriptValueEvent) {
// No refresh needed, a ScriptValueEvent is only generated in response to a ValueAction
return;
}
TYPE_CASE(action, ValueAction) {
if (action.card) refreshList(true);
}
}
void CardListBase::getItems(vector<VoidP>& out) const {
FOR_EACH(c, set->cards) {
out.push_back(c);
}
}
void CardListBase::sendEvent(int type) {
CardSelectEvent ev(type);
ev.SetEventObject(this);
ProcessEvent(ev);
}
void CardListBase::getSelection(vector<CardP>& out) const {
long count = GetItemCount();
for (long pos = 0 ; pos < count ; ++pos) {
if (const_cast<CardListBase*>(this)->IsSelected(pos)) {
out.push_back(getCard(pos));
}
}
}
// ----------------------------------------------------------------------------- : CardListBase : Clipboard
bool CardListBase::canCut() const { return canDelete(); }
bool CardListBase::canCopy() const { return focusCount() > 0; }
bool CardListBase::canPaste() const {
return allowModify();
}
bool CardListBase::canDelete() const {
return allowModify() && focusCount() > 0; // TODO: check for selection?
}
bool CardListBase::doCopy() {
if (!canCopy()) return false;
// cards to copy
vector<CardP> cards_to_copy;
getSelection(cards_to_copy);
if (cards_to_copy.empty()) return false;
// put on clipboard
if (!wxTheClipboard->Open()) return false;
bool ok = wxTheClipboard->SetData(new CardsOnClipboard(set, _(""), cards_to_copy)); // ignore result
wxTheClipboard->Close();
return ok;
}
bool CardListBase::doCopyCardAndLinkedCards() {
if (!canCopy()) return false;
vector<CardP> cards_selected;
getSelection(cards_selected);
if (cards_selected.size() < 1) return false;
if (!wxTheClipboard->Open()) return false;
vector<CardP> cards_to_copy;
unordered_set<CardP> cards_already_added;
FOR_EACH(card, cards_selected) {
if (cards_already_added.find(card) == cards_already_added.end()) {
cards_to_copy.push_back(card);
cards_already_added.insert(card);
}
vector<pair<CardP, String>> linked_cards = card->getLinkedCards(*set);
FOR_EACH(linked_card, linked_cards) {
if (cards_already_added.find(linked_card.first) == cards_already_added.end()) {
cards_to_copy.push_back(linked_card.first);
cards_already_added.insert(linked_card.first);
}
}
}
bool ok = wxTheClipboard->SetData(new CardsOnClipboard(set, _(""), cards_to_copy)); // ignore result
wxTheClipboard->Close();
return ok;
}
bool CardListBase::doPaste() {
if (!canPaste()) return false;
if (!wxTheClipboard->Open()) return false;
bool ok = wxTheClipboard->GetData(*drop_target->data_object);
wxTheClipboard->Close();
if (ok) return parseData(false);
return false;
}
bool CardListBase::doDelete() {
// cards to delete
vector<CardP> cards_to_delete;
getSelection(cards_to_delete);
if (cards_to_delete.empty()) return false;
// delete cards
set->actions.addAction(make_unique<AddCardAction>(REMOVE, *set, cards_to_delete));
return true;
}
bool CardListBase::doAddCSV() {
AddCSVWindow wnd(this, set, true);
if (wnd.ShowModal() == wxID_OK) {
// The actual adding is done in this window's onOk function
return true;
}
return false;
}
bool CardListBase::doAddJSON() {
AddJSONWindow wnd(this, set, true);
if (wnd.ShowModal() == wxID_OK) {
// The actual adding is done in this window's onOk function
return true;
}
return false;
}
bool CardListBase::doBulkModification() {
BulkModificationWindow wnd(this, set, true);
if (wnd.ShowModal() == wxID_OK) {
// The actual modifying is done in this window's onOk function
return true;
}
return false;
}
bool CardListBase::parseUrl(String& url, vector<CardP>& out) {
size_t j = out.size();
size_t pos = url.find("URL=");
if (pos != std::string::npos) {
url = url.substr(pos+4);
}
if (!url.StartsWith(_("http"))) return false;
WebRequestWindow wnd(this, url);
if (wnd.ShowModal() == wxID_OK) {
const String& content_type = wnd.out.GetContentType();
if (content_type.StartsWith(_("image"))) {
Image img(*wnd.out.GetStream());
if (img.IsOk()) {
parseImage(img, out);
}
else {
queue_message(MESSAGE_ERROR, _ERROR_("web request corrupted"));
}
}
else if (content_type.StartsWith(_("text"))) {
String text = wnd.out.AsString();
parseText(text, out);
}
else {
queue_message(MESSAGE_ERROR, _ERROR_("web request unsupported format"));
}
}
return j < out.size();
}
bool CardListBase::parseFiles(wxArrayString& filenames, vector<CardP>& out) {
size_t j = out.size();
for (size_t i = 0; i < filenames.size(); i++) {
// if it's an image file, try to get meta_data
Image image_file;
image_file.SetLoadFlags(image_file.GetLoadFlags() & ~wxImage::Load_Verbose);
if (image_file.LoadFile(filenames[i])) {
parseImage(image_file, out);
} else {
// if it's an url, request the data
std::ifstream ifs(filenames[i].ToStdString());
if (ifs.bad() || ifs.fail() || !ifs.good() || !ifs.is_open()) continue;
std::string content((std::istreambuf_iterator<char>(ifs)), (std::istreambuf_iterator<char>()));
wxString text(content);
if (!parseUrl(text, out)) parseText(text, out);
}
}
return j < out.size();
}
bool CardListBase::parseImage(Image& image, vector<CardP>& out) {
size_t j = out.size();
if (image.HasOption(wxIMAGE_OPTION_PNG_DESCRIPTION)) {
parseText(image.GetOption(wxIMAGE_OPTION_PNG_DESCRIPTION), out);
// crop image rects to populate image fields
for (; j < out.size(); j++) {
CardP& card = out[j];
for (IndexMap<FieldP, ValueP>::iterator it = card->data.begin(); it != card->data.end(); it++) {
ImageValue* value = dynamic_cast<ImageValue*>(it->get());
if (value && !value->filename.empty()) {
wxRect rect = wxRect(0,0,0,0);
int degrees = 0;
value->filename.getExternalRect(rect, degrees);
if (rect.width > 0 && rect.height > 0) {
Image& img = image.GetSubImage(rect);
img = rotate_image(img, deg_to_rad(360-degrees));
LocalFileName filename = set->newFileName((*it)->fieldP->name, settings.internal_image_extension ? _(".png") : _("")); // a new unique name in the package
img.SaveFile(set->nameOut(filename), wxBITMAP_TYPE_PNG);
value->filename = filename;
}
}
}
}
}
return j < out.size();
}
bool CardListBase::parseText(String& text, vector<CardP>& out) {
size_t j = out.size();
if (size_t pos = text.find("<mse-card-data>") != wxString::npos) {
text = text.substr(pos + 14, text.find("</mse-card-data>") - pos - 14);
}
try {
ScriptValueP& sv = json_to_mse(text, set.get());
if (sv->type() == SCRIPT_COLLECTION) {
if (ScriptCustomCollection* custom = dynamic_cast<ScriptCustomCollection*>(sv.get())) {
for (size_t i = 0; i < custom->value.size(); i++) {
if (ScriptObject<CardP>* c = dynamic_cast<ScriptObject<CardP>*>(custom->value[i].get())) {
out.push_back(make_intrusive<Card>(*c->getValue()));
}
}
}
} else if (ScriptObject<CardP>* c = dynamic_cast<ScriptObject<CardP>*>(sv.get())) {
out.push_back(make_intrusive<Card>(*c->getValue()));
}
} catch (...) {}
return j < out.size();
}
bool CardListBase::parseData(bool ignore_cards_from_own_card_list) {
wxBusyCursor wait;
wxDataFormat format = drop_target->data_object->GetReceivedFormat();
wxDataObject *data = drop_target->data_object->GetObject(format);
vector<CardP> new_cards;
if (CardsDataObject* card_data = dynamic_cast<CardsDataObject*>(data)) {
String id = ignore_cards_from_own_card_list ? drop_target->ignored_id : _("");
card_data->getCards(set, id, new_cards);
}
else switch (format.GetType())
{
case wxDF_FILENAME:
{
wxFileDataObject* file_data = static_cast<wxFileDataObject*>(data);
wxArrayString filenames = file_data->GetFilenames();
parseFiles(filenames, new_cards);
}
break;
case wxDF_PNG:
{
wxImageDataObject* image_data = static_cast<wxImageDataObject*>(data);
Image image = image_data->GetImage();
parseImage(image, new_cards);
}
break;
case wxDF_BITMAP:
{
wxBitmapDataObject* bitmap_data = static_cast<wxBitmapDataObject*>(data);
wxBitmap bitmap = bitmap_data->GetBitmap();
Image image = bitmap.ConvertToImage();
parseImage(image, new_cards);
}
break;
case wxDF_UNICODETEXT:
case wxDF_TEXT:
case wxDF_HTML:
{
wxTextDataObject* text_data = static_cast<wxTextDataObject*>(data);
String text = text_data->GetText();
if (!parseUrl(text, new_cards)) parseText(text, new_cards);
}
break;
default:
{
queue_message(MESSAGE_ERROR, _ERROR_("unknown data format"));
}
}
if (new_cards.size() > 0) {
set->actions.addAction(make_unique<AddCardAction>(ADD, *set, new_cards));
return true;
}
return false;
}
// --------------------------------------------------- : CardListBase : Card linking
bool CardListBase::canLink() const {
vector<CardP> selected_cards;
getSelection(selected_cards);
return selected_cards.size() == 1;
}
bool CardListBase::doLink() {
CardLinkWindow wnd(this, set, getCard());
if (wnd.ShowModal() == wxID_OK) {
// The actual linking is done in this window's onOk function
return true;
}
return false;
}
bool CardListBase::doUnlink(CardP unlinked_card) {
set->actions.addAction(make_unique<UnlinkCardsAction>(*set, getCard(), unlinked_card));
return true;
}
// ----------------------------------------------------------------------------- : CardListBase : Building the list
// Comparison object for comparing cards
bool CardListBase::compareItems(void* a, void* b) const {
FieldP sort_field = column_fields[sort_by_column];
ValueP va = reinterpret_cast<Card*>(a)->data[sort_field];
ValueP vb = reinterpret_cast<Card*>(b)->data[sort_field];
assert(va && vb);
// compare sort keys
int cmp = smart_compare( va->getSortKey(), vb->getSortKey() );
if (cmp != 0) return cmp < 0;
// equal values, compare alternate sort key
if (alternate_sort_field) {
ValueP va = reinterpret_cast<Card*>(a)->data[alternate_sort_field];
ValueP vb = reinterpret_cast<Card*>(b)->data[alternate_sort_field];
int cmp = smart_compare( va->getSortKey(), vb->getSortKey() );
if (cmp != 0) return cmp < 0;
}
return false;
}
void CardListBase::rebuild() {
ClearAll();
column_fields.clear();
selected_item_pos = -1;
onRebuild();
if (!set) return;
// init stuff
set->game->initCardListColorScript();
// determine column order
map<int,FieldP> new_column_fields;
FOR_EACH(f, set->game->card_fields) {
ColumnSettings& cs = settings.columnSettingsFor(*set->game, *f);
if (cs.visible && f->card_list_allow) {
new_column_fields[cs.position] = f;
}
}
// add columns
FOR_EACH(f, new_column_fields) {
ColumnSettings& cs = settings.columnSettingsFor(*set->game, *f.second);
int align;
if (f.second->card_list_align & ALIGN_RIGHT) align = wxLIST_FORMAT_RIGHT;
else if (f.second->card_list_align & ALIGN_CENTER) align = wxLIST_FORMAT_CENTRE;
else align = wxLIST_FORMAT_LEFT;
InsertColumn((long)column_fields.size(), f.second->card_list_name.get(), align, cs.width);
column_fields.push_back(f.second);
}
// determine sort settings
GameSettings& gs = settings.gameSettingsFor(*set->game);
sort_ascending = gs.sort_cards_ascending;
sort_by_column = -1;
long i = 0;
FOR_EACH(f, column_fields) {
if (f->name == gs.sort_cards_by) {
// we are sorting by this column
sort_by_column = i;
// and display an arrow in the header
SetColumnImage(i, sort_ascending ? 0 : 1);
}
++i;
}
// determine alternate sortImageFieldP ImageCardList::findImageField() {
alternate_sort_field = FieldP();
FOR_EACH(f, set->game->card_fields) {
if (f->identifying) {
alternate_sort_field = f;
break;
}
}
// refresh
refreshList();
}
void CardListBase::sortBy(long column, bool ascending) {
ItemList::sortBy(column, ascending);
storeColumns();
// sort all other card lists in this window
SetWindow* set_window = dynamic_cast<SetWindow*>(wxGetTopLevelParent(this));
if (set_window) {
for (auto card_list : set_window->getCardLists()) {
if (card_list != this) {
card_list->ItemList::sortBy(column, ascending);
}
}
}
}
// ----------------------------------------------------------------------------- : CardListBase : Columns
void CardListBase::storeColumns() {
if (!set) return;
// store column widths
int i = 0;
FOR_EACH(f, column_fields) {
ColumnSettings& cs = settings.columnSettingsFor(*set->game, *f);
cs.width = GetColumnWidth(i++);
}
// store sorting
GameSettings& gs = settings.gameSettingsFor(*set->game);
if (sort_by_column >= 0) gs.sort_cards_by = column_fields.at(sort_by_column)->name;
else gs.sort_cards_by = _("");
gs.sort_cards_ascending = sort_ascending;
}
void CardListBase::selectColumns() {
CardListColumnSelectDialog wnd(this, set->game);
if (wnd.ShowModal() == wxID_OK) {
storeColumns();
// rebuild all card lists this window
rebuild();
SetWindow* set_window = dynamic_cast<SetWindow*>(wxGetTopLevelParent(this));
if (set_window) {
for (auto card_list : set_window->getCardLists()) {
if (card_list != this) {
card_list->rebuild();
}
}
}
}
}
// ----------------------------------------------------------------------------- : CardListBase : Item 'events'
String CardListBase::OnGetItemText(long pos, long col) const {
if (col < 0 || (size_t)col >= column_fields.size()) {
// wx may give us non existing columns!
return _("");
}
ValueP val = getCard(pos)->data[column_fields[col]];
if (val) return val->toString();
else return _("");
}
int CardListBase::OnGetItemImage(long pos) const {
return -1;
}
wxListItemAttr* CardListBase::OnGetItemAttr(long pos) const {
if (!set->game->card_list_color_script) return nullptr;
Context& ctx = set->getContext(getCard(pos));
item_attr.SetTextColour(set->game->card_list_color_script.invoke(ctx)->toColor());
return &item_attr;
}
// ----------------------------------------------------------------------------- : CardListBase : Window events
void CardListBase::onColumnRightClick(wxListEvent&) {
// show menu
wxMenu m;
m.Append(ID_SELECT_COLUMNS, _MENU_("card list columns"), _HELP_("card list columns"));
PopupMenu(&m);
}
void CardListBase::onColumnResize(wxListEvent& ev) {
storeColumns();
int col = ev.GetColumn();
int width = GetColumnWidth(col);
// update this and all other card lists in this window
SetColumnWidth(col, width);
SetWindow* set_window = dynamic_cast<SetWindow*>(wxGetTopLevelParent(this));
if (set_window) {
for (auto card_list : set_window->getCardLists()) {
if (card_list != this) {
card_list->SetColumnWidth(col, width);
}
}
}
}
void CardListBase::onSelectColumns(wxCommandEvent&) {
selectColumns();
}
void CardListBase::onChar(wxKeyEvent& ev) {
if (ev.GetKeyCode() == WXK_DELETE && allowModify()) {
doDelete();
} else if (ev.GetKeyCode() == WXK_TAB) {
// send a navigation event to our parent, to select another control
// we need this because tabs are not handled on the cards panel
wxNavigationKeyEvent nev;
nev.SetDirection(!ev.ShiftDown());
GetParent()->HandleWindowEvent(nev);
} else {
ev.Skip();
}
}
void CardListBase::onBeginDrag(wxListEvent&) {
vector<CardP> cards;
getSelection(cards);
String transaction_id = generate_uid();
CardsOnClipboard* card_data = new CardsOnClipboard(set, transaction_id, cards);
drop_target->ignored_id = transaction_id;
wxDropSource drag_source(this);
drag_source.SetData(*card_data);
drag_source.DoDragDrop(wxDrag_CopyOnly);
}
void CardListBase::onDrag(wxMouseEvent& ev) {
ev.Skip();
if (!allowModify()) return;
if (ev.Dragging() && selected_item && sort_by_column < 0) {
// reorder card list
int flags;
long item = HitTest(ev.GetPosition(), flags);
if (flags & wxLIST_HITTEST_ONITEM) {
if (item > 0) EnsureVisible(item-1);
if (item < GetItemCount()-1) EnsureVisible(item+1);
findSelectedItemPos();
if (item != selected_item_pos) {
// move card in the set
set->actions.addAction(make_unique<ReorderCardsAction>(*set, item, selected_item_pos));
}
ev.Skip(false);
}
}
}
void CardListBase::onContextMenu(wxContextMenuEvent&) {
if (allowModify()) {
wxMenu m;
add_menu_item_tr(&m, wxID_CUT, settings.darkModePrefix() + "cut", "cut_card");
add_menu_item_tr(&m, wxID_COPY, "copy", "copy_card");
add_menu_item_tr(&m, ID_CARD_AND_LINK_COPY, "card_copy", "copy card and links");
add_menu_item_tr(&m, wxID_PASTE, "paste", "paste_card");
m.AppendSeparator();
add_menu_item_tr(&m, ID_CARD_ADD, "card_add", "add card");
add_menu_item_tr(&m, ID_CARD_REMOVE, "card_del", "remove card");
add_menu_item_tr(&m, ID_CARD_LINK, "card_link", "link card");
PopupMenu(&m);
}
}
void CardListBase::onItemActivate(wxListEvent& ev) {
selectItemPos(ev.GetIndex(), false);
sendEvent(EVENT_CARD_ACTIVATE);
}
// ----------------------------------------------------------------------------- : CardListDropTarget
CardListDropTarget::CardListDropTarget(CardListBase* card_list)
: card_list(card_list), ignored_id(_(""))
{
data_object = new wxDataObjectComposite();
data_object->Add(new CardsDataObject(), true);
data_object->Add(new wxFileDataObject());
data_object->Add(new wxImageDataObject());
data_object->Add(new wxTextDataObject());
SetDataObject(data_object);
}
CardListDropTarget::~CardListDropTarget() {}
wxDragResult CardListDropTarget::OnData(wxCoord x, wxCoord y, wxDragResult defaultDragResult) {
if (!GetData()) return wxDragNone;
if (!card_list->parseData(true)) return wxDragError;
return wxDragCopy;
}
// ----------------------------------------------------------------------------- : CardListBase : Event table
BEGIN_EVENT_TABLE(CardListBase, ItemList)
EVT_LIST_COL_RIGHT_CLICK (wxID_ANY, CardListBase::onColumnRightClick)
EVT_LIST_COL_END_DRAG (wxID_ANY, CardListBase::onColumnResize)
EVT_LIST_ITEM_ACTIVATED (wxID_ANY, CardListBase::onItemActivate)
EVT_LIST_BEGIN_DRAG (wxID_ANY, CardListBase::onBeginDrag)
EVT_CHAR ( CardListBase::onChar)
EVT_MOTION ( CardListBase::onDrag)
EVT_MENU (ID_SELECT_COLUMNS, CardListBase::onSelectColumns)
EVT_CONTEXT_MENU ( CardListBase::onContextMenu)
END_EVENT_TABLE ()