ModXMLData Struct Reference

#include <C4StartupModsDlg.h>

Classes
struct	FileInfo

Public Types
enum class	Source { Unknown , Local , Overview , DetailView }

Public Member Functions
bool	requiresUpdate () const
	ModXMLData (const TiXmlElement *xml, Source source=Source::Unknown)
	~ModXMLData ()

Public Attributes
std::vector< FileInfo >	files
std::vector< std::string >	dependencies
std::vector< std::string >	tags
std::string	title
std::string	id
std::string	description
std::string	longDescription
std::string	slug
bool	metadataMissing { false }
Source	source { Source::Unknown }
TiXmlNode *	originalXMLElement { nullptr }

Detailed Description

Definition at line 35 of file C4StartupModsDlg.h.

---

Class Documentation

ModXMLData::FileInfo

struct ModXMLData::FileInfo

Definition at line 37 of file C4StartupModsDlg.h.

Class Members
string	handle
string	name
string	sha1
size_t	size

Member Enumeration Documentation

Source

enum ModXMLData::Source

strong

Enumerator
Unknown
Local
Overview
DetailView

Definition at line 54 of file C4StartupModsDlg.h.

    {
        Unknown,
        Local,
        Overview,
        DetailView
    };

Constructor & Destructor Documentation

ModXMLData()

ModXMLData::ModXMLData	(	const TiXmlElement *	xml,
		Source	source = Source::Unknown
	)

Definition at line 56 of file C4StartupModsDlg.cpp.

{
 
    // Remember whether the loaded the element from a local file / overview, because we
    // then still have to do a query if we want to update.
    this->source = source;
    // It is possible to instantiate this without valid XML.
    if (xml == nullptr)
    {
        metadataMissing = true;
        return;
    }
    // Remember the XML element in case we need to pretty-print it later.
    originalXMLElement = xml->Clone();
    id = getSafeStringValue(xml, "id", "");
    title = getSafeStringValue(xml, "title", "");
    assert(IsValidUtf8(title.c_str()));
    slug = getSafeStringValue(xml, "slug", title);
    assert(IsValidUtf8(slug.c_str()));
    description = getSafeStringValue(xml, "description");
    assert(IsValidUtf8(description.c_str()));
    longDescription = getSafeStringValue(xml, "long_description");
    if (!description.empty())
    {
        const bool descriptionNeedsCut = description.size() > 150;
        if (descriptionNeedsCut)
        {
            // Find a cutoff that is not inside a UTF-8 character.
            std::string::size_type characterCount{ 0 };
            for (const char* c = description.data(); *c != '\0';)
            {
                const uint8_t val = *c;
                if (val <= 127)
                {
                    c += 1;
                }
                else
                {
                    GetNextUTF8Character(&c);
                }
                characterCount += 1;
 
                const bool shouldCutHere = characterCount >= 150;
                if (shouldCutHere)
                {
                    uint32_t byteDifference = c - description.data();
                    description.resize(byteDifference);
                    break;
                }
            }
        }
    }
    assert(IsValidUtf8(description.c_str()));
    // Additional meta-information.
 
    const TiXmlElement* dependencies_node = xml->FirstChildElement("dependencies");
    if (dependencies_node != nullptr)
        for (const TiXmlElement *node = dependencies_node->FirstChildElement("item"); node != nullptr; node = node->NextSiblingElement("item"))
        {
            const char *depID = node->GetText();
            if (depID != nullptr)
                dependencies.push_back(depID);
        }
 
    const TiXmlElement* tags_node = xml->FirstChildElement("tags");
    if (tags_node != nullptr)
        for (const TiXmlElement *node = tags_node->FirstChildElement("item"); node != nullptr; node = node->NextSiblingElement("item"))
        {
            const std::string tag = node->GetText();
            if (!tag.empty())
                tags.push_back(tag);
        }
 
    const TiXmlElement* files_node = xml->FirstChildElement("files");
    if (files_node != nullptr)
        for (const TiXmlElement *filenode = files_node->FirstChildElement("item"); filenode != nullptr; filenode = filenode->NextSiblingElement("item"))
        {
            // We guarantee that we do not modify the handle below, thus the const_cast is safe.
            const TiXmlHandle nodeHandle(const_cast<TiXmlNode*> (static_cast<const TiXmlNode*> (filenode)));
 
            const std::string handle = getSafeStringValue(filenode, "id", "");
            const std::string name = getSafeStringValue(filenode, "filename", "");
            const std::string lengthString = getSafeStringValue(filenode, "length", "");
 
            const std::string hashSHA1 = getSafeStringValue(filenode, "sha1", "");
 
            if (handle.empty() || name.empty() || lengthString.empty()) continue;
            size_t length{ 0 };
 
            try
            {
                length = std::stoi(lengthString);
            }
            catch (...)
            {
                continue;
            }
         
            files.emplace_back(FileInfo{ handle, length, name, hashSHA1 });
        }
}

References dependencies, description, files, GetNextUTF8Character(), getSafeStringValue(), IsValidUtf8(), longDescription, metadataMissing, originalXMLElement, slug, source, tags, and title.

Here is the call graph for this function:

~ModXMLData()

ModXMLData::~ModXMLData

(

)

Definition at line 158 of file C4StartupModsDlg.cpp.

{
    delete originalXMLElement;
    originalXMLElement = nullptr;
}

References originalXMLElement.

Member Function Documentation

requiresUpdate()

bool ModXMLData::requiresUpdate ( ) const

inline

Definition at line 62 of file C4StartupModsDlg.h.

{ return source != Source::DetailView; }

References DetailView, and source.

Member Data Documentation

dependencies

std::vector<std::string> ModXMLData::dependencies

Definition at line 45 of file C4StartupModsDlg.h.

Referenced by ModXMLData().

description

std::string ModXMLData::description

Definition at line 49 of file C4StartupModsDlg.h.

Referenced by ModXMLData().

files

std::vector<FileInfo> ModXMLData::files

Definition at line 44 of file C4StartupModsDlg.h.

Referenced by C4StartupModsListEntry::GetFileInfos(), and ModXMLData().

id

std::string ModXMLData::id

Definition at line 48 of file C4StartupModsDlg.h.

Referenced by C4StartupModsListEntry::GetID().

longDescription

std::string ModXMLData::longDescription

Definition at line 49 of file C4StartupModsDlg.h.

Referenced by ModXMLData().

metadataMissing

bool ModXMLData::metadataMissing { false }

Definition at line 51 of file C4StartupModsDlg.h.

Referenced by ModXMLData().

originalXMLElement

TiXmlNode* ModXMLData::originalXMLElement { nullptr }

Definition at line 68 of file C4StartupModsDlg.h.

Referenced by C4StartupModsListEntry::GetXMLNode(), ModXMLData(), and ~ModXMLData().

slug

std::string ModXMLData::slug

Definition at line 50 of file C4StartupModsDlg.h.

Referenced by ModXMLData().

source

Source ModXMLData::source { Source::Unknown }

Definition at line 61 of file C4StartupModsDlg.h.

Referenced by C4StartupModsListEntry::IsLoadedFromLocal(), ModXMLData(), and requiresUpdate().

tags

std::vector<std::string> ModXMLData::tags

Definition at line 46 of file C4StartupModsDlg.h.

Referenced by ModXMLData().

title

std::string ModXMLData::title

Definition at line 47 of file C4StartupModsDlg.h.

Referenced by C4StartupModsListEntry::GetTitle(), and ModXMLData().

---

The documentation for this struct was generated from the following files:

• C4StartupModsDlg.h
• C4StartupModsDlg.cpp