jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-09-24 02:13:02 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

[DeckList] Make deck metadata XML serialization instance methods

Browse source
This commit is contained in:
Lukas Brübach 2026-09-18 09:52:12 +02:00 • committed by GitHub
parent 6669c341a9
commit 629f7dee64
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 47 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

1
libcockatrice_deck_list/CMakeLists.txt
View file

@ -9,7 +9,6 @@ set(HEADERS
libcockatrice/deck_list/tree/inner_deck_list_node.h libcockatrice/deck_list/tree/inner_deck_list_node.h
libcockatrice/deck_list/deck_list.h libcockatrice/deck_list/deck_list.h
libcockatrice/deck_list/deck_list_history_manager.h libcockatrice/deck_list/deck_list_history_manager.h
libcockatrice/deck_list/deck_list_metadata_xml.h
libcockatrice/deck_list/deck_list_node_tree.h libcockatrice/deck_list/deck_list_node_tree.h
libcockatrice/deck_list/deck_list_memento.h libcockatrice/deck_list/deck_list_memento.h
libcockatrice/deck_list/deck_list_plain_text_parser.h libcockatrice/deck_list/deck_list_plain_text_parser.h

5
libcockatrice_deck_list/libcockatrice/deck_list/deck_list.cpp
View file

@ -1,7 +1,6 @@
#include "deck_list.h" #include "deck_list.h"
#include "deck_list_memento.h" #include "deck_list_memento.h"
#include "deck_list_metadata_xml.h"
#include "deck_list_plain_text_parser.h" #include "deck_list_plain_text_parser.h"
#include "tree/abstract_deck_list_node.h" #include "tree/abstract_deck_list_node.h"
#include "tree/deck_list_card_node.h" #include "tree/deck_list_card_node.h"
@ -55,7 +54,7 @@ bool DeckList::readElement(QXmlStreamReader *xml)
{ {
const QString childName = xml->name().toString(); const QString childName = xml->name().toString();
if (xml->isStartElement()) { if (xml->isStartElement()) {
if (DeckListMetadataXml::readElement(xml, childName, metadata)) { if (metadata.readElement(xml, childName)) {
return true; return true;
} }
if (childName == "zone") { if (childName == "zone") {
@ -77,7 +76,7 @@ void DeckList::write(QXmlStreamWriter *xml) const
xml->writeStartElement("cockatrice_deck"); xml->writeStartElement("cockatrice_deck");
xml->writeAttribute("version", "1"); xml->writeAttribute("version", "1");
DeckListMetadataXml::write(xml, metadata); metadata.write(xml);
// Write zones // Write zones
tree.write(xml); tree.write(xml);

17
libcockatrice_deck_list/libcockatrice/deck_list/deck_list.h
View file

@ -76,6 +76,23 @@ public:
* @brief Checks if all values (except for lastLoadedTimestamp) in the metadata is empty. * @brief Checks if all values (except for lastLoadedTimestamp) in the metadata is empty.
*/ */
bool isEmpty() const; bool isEmpty() const;
/**
* @brief Reads a single deck metadata element from a Cockatrice deck XML stream.
*
* @param xml Reader positioned at the element.
* @param childName Name of the current element.
* @return true if a metadata element was consumed, false if @p childName is
* not a metadata element.
*/
bool readElement(QXmlStreamReader *xml, const QString &childName);
/**
* @brief Writes the deck metadata section of a Cockatrice deck XML file.
*
* @param xml Writer to append the metadata elements to.
*/
void write(QXmlStreamWriter *xml) const;
}; };
private: private:

58
libcockatrice_deck_list/libcockatrice/deck_list/deck_list_metadata_xml.cpp
View file

@ -1,10 +1,10 @@
#include "deck_list_metadata_xml.h" #include "deck_list.h"
#include <QtCore/QXmlStreamReader> #include <QtCore/QXmlStreamReader>
#include <QtCore/QXmlStreamWriter> #include <QtCore/QXmlStreamWriter>
#include <libcockatrice/utility/playmat_params.h> #include <libcockatrice/utility/playmat_params.h>
namespace DeckListMetadataXml namespace
{ {
/** /**
@ -20,7 +20,7 @@ namespace DeckListMetadataXml
* @param max Upper clamp bound. * @param max Upper clamp bound.
* @return The parsed value clamped to [min, max], or @p fallback. * @return The parsed value clamped to [min, max], or @p fallback.
*/ */
static double parseClampedParam(const QString &valueString, double fallback, double min, double max) double parseClampedParam(const QString &valueString, double fallback, double min, double max)
{ {
bool ok = false; bool ok = false;
const double value = valueString.toDouble(&ok); const double value = valueString.toDouble(&ok);
@ -30,20 +30,22 @@ static double parseClampedParam(const QString &valueString, double fallback, dou
return qBound(min, value, max); return qBound(min, value, max);
} }
bool readElement(QXmlStreamReader *xml, const QString &childName, DeckList::Metadata &metadata) } // namespace
bool DeckList::Metadata::readElement(QXmlStreamReader *xml, const QString &childName)
{ {
if (childName == "lastLoadedTimestamp") { if (childName == "lastLoadedTimestamp") {
metadata.lastLoadedTimestamp = xml->readElementText(); lastLoadedTimestamp = xml->readElementText();
} else if (childName == "deckname") { } else if (childName == "deckname") {
metadata.name = xml->readElementText(); name = xml->readElementText();
} else if (childName == "format") { } else if (childName == "format") {
metadata.gameFormat = xml->readElementText(); gameFormat = xml->readElementText();
} else if (childName == "comments") { } else if (childName == "comments") {
metadata.comments = xml->readElementText(); comments = xml->readElementText();
} else if (childName == "bannerCard") { } else if (childName == "bannerCard") {
QString providerId = xml->attributes().value("providerId").toString(); QString providerId = xml->attributes().value("providerId").toString();
QString cardName = xml->readElementText(); QString cardName = xml->readElementText();
metadata.bannerCard = {cardName, providerId}; bannerCard = {cardName, providerId};
} else if (childName == "playmatCard") { } else if (childName == "playmatCard") {
QString providerId = xml->attributes().value("providerId").toString(); QString providerId = xml->attributes().value("providerId").toString();
// Attributes are read before readElementText consumes the element. // Attributes are read before readElementText consumes the element.
@ -52,7 +54,6 @@ bool readElement(QXmlStreamReader *xml, const QString &childName, DeckList::Meta
QString vOffStr = xml->attributes().value("verticalOffset").toString(); QString vOffStr = xml->attributes().value("verticalOffset").toString();
QString zoomStr = xml->attributes().value("zoom").toString(); QString zoomStr = xml->attributes().value("zoom").toString();
QString cardName = xml->readElementText(); QString cardName = xml->readElementText();
PlaymatInfo playmat;
playmat.card = {cardName, providerId}; playmat.card = {cardName, providerId};
// Clamp to the same ranges as the settings dialog and the remote // Clamp to the same ranges as the settings dialog and the remote
// player-properties path so malformed deck files cannot produce // player-properties path so malformed deck files cannot produce
@ -61,12 +62,11 @@ bool readElement(QXmlStreamReader *xml, const QString &childName, DeckList::Meta
playmat.params.marginPctR = parseClampedParam(marginRStr, 0.07, 0.0, 0.95); playmat.params.marginPctR = parseClampedParam(marginRStr, 0.07, 0.0, 0.95);
playmat.params.verticalOffset = parseClampedParam(vOffStr, 0.33, 0.0, 1.0); playmat.params.verticalOffset = parseClampedParam(vOffStr, 0.33, 0.0, 1.0);
playmat.params.zoom = parseClampedParam(zoomStr, 1.0, 0.1, 4.0); playmat.params.zoom = parseClampedParam(zoomStr, 1.0, 0.1, 4.0);
metadata.playmat = playmat;
} else if (childName == "tags") { } else if (childName == "tags") {
metadata.tags.clear(); // Clear existing tags tags.clear(); // Clear existing tags
while (xml->readNextStartElement()) { while (xml->readNextStartElement()) {
if (xml->name().toString() == "tag") { if (xml->name().toString() == "tag") {
metadata.tags.append(xml->readElementText()); tags.append(xml->readElementText());
} }
} }
} else { } else {
@ -75,33 +75,31 @@ bool readElement(QXmlStreamReader *xml, const QString &childName, DeckList::Meta
return true; return true;
} }
void write(QXmlStreamWriter *xml, const DeckList::Metadata &metadata) void DeckList::Metadata::write(QXmlStreamWriter *xml) const
{ {
xml->writeTextElement("lastLoadedTimestamp", metadata.lastLoadedTimestamp); xml->writeTextElement("lastLoadedTimestamp", lastLoadedTimestamp);
xml->writeTextElement("deckname", metadata.name); xml->writeTextElement("deckname", name);
xml->writeTextElement("format", metadata.gameFormat); xml->writeTextElement("format", gameFormat);
xml->writeStartElement("bannerCard"); xml->writeStartElement("bannerCard");
xml->writeAttribute("providerId", metadata.bannerCard.providerId); xml->writeAttribute("providerId", bannerCard.providerId);
xml->writeCharacters(metadata.bannerCard.name); xml->writeCharacters(bannerCard.name);
xml->writeEndElement(); xml->writeEndElement();
if (!metadata.playmat.card.isEmpty()) { if (!playmat.card.isEmpty()) {
xml->writeStartElement("playmatCard"); xml->writeStartElement("playmatCard");
xml->writeAttribute("providerId", metadata.playmat.card.providerId); xml->writeAttribute("providerId", playmat.card.providerId);
xml->writeAttribute("marginPctL", QString::number(metadata.playmat.params.marginPctL, 'f', 4)); xml->writeAttribute("marginPctL", QString::number(playmat.params.marginPctL, 'f', 4));
xml->writeAttribute("marginPctR", QString::number(metadata.playmat.params.marginPctR, 'f', 4)); xml->writeAttribute("marginPctR", QString::number(playmat.params.marginPctR, 'f', 4));
xml->writeAttribute("verticalOffset", QString::number(metadata.playmat.params.verticalOffset, 'f', 4)); xml->writeAttribute("verticalOffset", QString::number(playmat.params.verticalOffset, 'f', 4));
xml->writeAttribute("zoom", QString::number(metadata.playmat.params.zoom, 'f', 4)); xml->writeAttribute("zoom", QString::number(playmat.params.zoom, 'f', 4));
xml->writeCharacters(metadata.playmat.card.name); xml->writeCharacters(playmat.card.name);
xml->writeEndElement(); xml->writeEndElement();
} }
xml->writeTextElement("comments", metadata.comments); xml->writeTextElement("comments", comments);
// Write tags // Write tags
xml->writeStartElement("tags"); xml->writeStartElement("tags");
for (const QString &tag : metadata.tags) { for (const QString &tag : tags) {
xml->writeTextElement("tag", tag); xml->writeTextElement("tag", tag);
} }
xml->writeEndElement(); xml->writeEndElement();
} }
} // namespace DeckListMetadataXml

35
libcockatrice_deck_list/libcockatrice/deck_list/deck_list_metadata_xml.h
View file

@ -1,35 +0,0 @@
#ifndef COCKATRICE_DECK_LIST_METADATA_XML_H
#define COCKATRICE_DECK_LIST_METADATA_XML_H
#include "deck_list.h"
#include <QString>
class QXmlStreamReader;
class QXmlStreamWriter;
namespace DeckListMetadataXml
{
/**
* @brief Reads a single deck metadata element from a Cockatrice deck XML stream.
*
* @param xml Reader positioned at the element.
* @param childName Name of the current element.
* @param metadata Metadata to fill in.
* @return true if a metadata element was consumed, false if @p childName is
* not a metadata element.
*/
bool readElement(QXmlStreamReader *xml, const QString &childName, DeckList::Metadata &metadata);
/**
* @brief Writes the deck metadata section of a Cockatrice deck XML file.
*
* @param xml Writer to append the metadata elements to.
* @param metadata The metadata to serialize.
*/
void write(QXmlStreamWriter *xml, const DeckList::Metadata &metadata);
} // namespace DeckListMetadataXml
#endif // COCKATRICE_DECK_LIST_METADATA_XML_H