mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-07-28 11:50:25 -07:00
749223c2dc
* [Card Database] Improve loading times through binary cache Took 10 minutes Took 9 minutes Took 16 seconds * [Card Database] Remove lib qt include Took 18 minutes Took 14 seconds * Downgrade to 6.3 datastream Took 5 minutes * go up to 6.4 datastream Took 1 minute * Address comments * Small bug fixes Took 20 minutes Took 10 seconds * More fixes. Took 4 minutes Took 4 seconds * Even more fixes. Took 11 minutes Took 4 seconds * More fixes. Took 6 minutes Took 26 seconds Took 8 minutes * Namespace instead of class Took 6 minutes --------- Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
117 lines
4.5 KiB
C++
117 lines
4.5 KiB
C++
#ifndef CARDDATABASE_PARSER_H
|
|
#define CARDDATABASE_PARSER_H
|
|
|
|
#include "../../card_info.h"
|
|
#include "../card_database_data.h"
|
|
|
|
#include <QIODevice>
|
|
#include <QString>
|
|
|
|
#define COCKATRICE_XML_XSI_NAMESPACE "http://www.w3.org/2001/XMLSchema-instance"
|
|
|
|
/**
|
|
* @class ICardDatabaseParser
|
|
* @ingroup CardDatabase
|
|
* @brief Defines the base parser interface (ICardDatabaseParser) for all card database parsers.
|
|
*
|
|
* Provides methods for checking file compatibility, parsing, and saving card databases.
|
|
* Also provides shared access to the global set list for cross-referencing.
|
|
*/
|
|
class ICardDatabaseParser : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
ICardDatabaseParser(ICardSetPriorityController *cardSetPriorityController);
|
|
~ICardDatabaseParser() override = default;
|
|
|
|
/**
|
|
* @brief Checks whether this parser can parse the given file.
|
|
* @param name File name (used for extension checks).
|
|
* @param device QIODevice representing the file content.
|
|
* @return true if the parser can handle this file.
|
|
*/
|
|
virtual bool getCanParseFile(const QString &name, QIODevice &device) = 0;
|
|
|
|
/**
|
|
* @brief Parses a database file and emits addCard/addSet signals.
|
|
* @param device QIODevice representing the file content.
|
|
*/
|
|
virtual void parseFile(QIODevice &device) = 0;
|
|
|
|
/**
|
|
* @brief Parses a database file into the given snapshot, without emitting
|
|
* any signals. Used for background loads that swap the snapshot into
|
|
* the live database once complete.
|
|
* @param device QIODevice representing the file content.
|
|
* @param data Target snapshot to populate.
|
|
*/
|
|
virtual void parseFileInto(QIODevice &device, CardDatabaseData &data) = 0;
|
|
|
|
/**
|
|
* @brief Saves card and set data to a file.
|
|
* @param _formats
|
|
* @param sets Map of sets to save.
|
|
* @param cards Map of cards to save.
|
|
* @param fileName Target file path.
|
|
* @param sourceUrl Optional source URL of the database.
|
|
* @param sourceVersion Optional version string of the source.
|
|
* @return true if save succeeded.
|
|
*/
|
|
virtual bool saveToFile(FormatRulesNameMap _formats,
|
|
SetNameMap sets,
|
|
CardNameMap cards,
|
|
const QString &fileName,
|
|
const QString &sourceUrl = "unknown",
|
|
const QString &sourceVersion = "unknown") = 0;
|
|
|
|
/** @brief Clears the cached global set list. */
|
|
static void clearSetlist();
|
|
|
|
protected:
|
|
/** @brief Cached global list of sets shared between all parsers. */
|
|
static SetNameMap sets;
|
|
ICardSetPriorityController *cardSetPriorityController;
|
|
|
|
/**
|
|
* @brief Snapshot the current parse is filling, or nullptr when emitting signals.
|
|
*
|
|
* This is an implicit-inheritance-via-member-variable pattern: parseFileInto()
|
|
* sets this before delegating to parseFile(), and loadCardsFromXml() /
|
|
* loadFormats() check it to decide between direct insertion and signal
|
|
* emission. Safe under the current model because loadFromFileMutex serialises
|
|
* all parser access and parseFile() is never re-entered. If a future change
|
|
* adds parallel parsing or a second parseFileInto() call within parseFile(),
|
|
* this pointer would race -- at that point refactor to pass CardDatabaseData*
|
|
* through the call chain instead. However, we are mostly RAM, not CPU bound on
|
|
* DB startup at this point so there's not much point to parallel parsing.
|
|
*/
|
|
CardDatabaseData *targetData = nullptr;
|
|
|
|
/**
|
|
* @brief Internal helper to add a set to the global set cache.
|
|
* @param setName Short set name.
|
|
* @param longName Optional full name.
|
|
* @param setType Optional set type string.
|
|
* @param releaseDate Optional release date.
|
|
* @param priority Optional priority (fallback if not specified).
|
|
* @return Pointer to the added or existing CardSet instance.
|
|
*/
|
|
CardSetPtr internalAddSet(const QString &setName,
|
|
const QString &longName = "",
|
|
const QString &setType = "",
|
|
const QDate &releaseDate = QDate(),
|
|
const CardSet::Priority priority = CardSet::PriorityFallback);
|
|
|
|
signals:
|
|
/** Emitted when a card is loaded from the database. */
|
|
void addCard(CardInfoPtr card);
|
|
|
|
/** Emitted when a set is loaded from the database. */
|
|
void addSet(CardSetPtr set);
|
|
|
|
void addFormat(FormatRulesPtr format);
|
|
};
|
|
|
|
Q_DECLARE_INTERFACE(ICardDatabaseParser, "ICardDatabaseParser")
|
|
|
|
#endif
|