A class that parses update server data format. More...

#include <UpdateDataParser.h>

Inheritance diagram for UpdateDataParser:

Collaboration diagram for UpdateDataParser:

Public Member Functions
	UpdateDataParser ()

	~UpdateDataParser ()

bool	Parse (const VersionPatch::UpdateDataFormat &updateData, VersionPatch *versionPatch)
	Parsing from update data format to VersionPatch fields. More...

Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()

virtual	~XMLTagHandler ()

virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0

virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))

virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))

virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0

void	ReadXMLEndTag (const char *tag)

void	ReadXMLContent (const char *s, int len)

XMLTagHandler *	ReadXMLChild (const char *tag)

Private Types
enum class	XmlParsedTags : int { kNotUsedTag , kUpdateTag , kDescriptionTag , kOsTag , kWin32Tag , kWin64Tag , kMacosTag , kLinuxTag , kVersionTag , kLinkTag }

Private Member Functions
bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override

void	HandleXMLEndTag (const std::string_view &tag) override

void	HandleXMLContent (const std::string_view &content) override

XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override

wxArrayString	SplitChangelogSentences (const wxString &changelogContent)

Private Attributes
XmlParsedTags	mXmlParsingState { XmlParsedTags::kNotUsedTag }

std::map< XmlParsedTags, const char * >	mXmlTagNames

VersionPatch *	mVersionPatch { nullptr }

Detailed Description

A class that parses update server data format.

Definition at line 19 of file UpdateDataParser.h.

Member Enumeration Documentation

◆ XmlParsedTags

enum class UpdateDataParser::XmlParsedTags : int

strongprivate

Enumerator
kNotUsedTag
kUpdateTag
kDescriptionTag
kOsTag
kWin32Tag
kWin64Tag
kMacosTag
kLinuxTag
kVersionTag
kLinkTag

Definition at line 34 of file UpdateDataParser.h.

                             : int {
        kNotUsedTag,
        kUpdateTag,
        kDescriptionTag,
        kOsTag,
        kWin32Tag,
        kWin64Tag,
        kMacosTag,
        kLinuxTag,
        kVersionTag,
        kLinkTag
    };

Constructor & Destructor Documentation

◆ UpdateDataParser()

UpdateDataParser::UpdateDataParser ( )

Definition at line 16 of file UpdateDataParser.cpp.

17{}

◆ ~UpdateDataParser()

UpdateDataParser::~UpdateDataParser ( )

Definition at line 19 of file UpdateDataParser.cpp.

20{}

Member Function Documentation

◆ HandleXMLChild()

XMLTagHandler * UpdateDataParser::HandleXMLChild ( const std::string_view & tag )

overrideprivatevirtual

Implements XMLTagHandler.

Definition at line 163 of file UpdateDataParser.cpp.

{
    for (auto& xmlTag : mXmlTagNames)
    {
        if (tag == xmlTag.second)
            return this;
    }
 
    return NULL;
}

References mXmlTagNames.

◆ HandleXMLContent()

void UpdateDataParser::HandleXMLContent ( const std::string_view & content )

overrideprivate

Definition at line 134 of file UpdateDataParser.cpp.

{
    if (mVersionPatch == nullptr)
        return;
 
    wxString trimmedContent = std::string(content);
 
    switch (mXmlParsingState)
    {
    case XmlParsedTags::kDescriptionTag:
        trimmedContent.Trim(true).Trim(false);
        mVersionPatch->changelog = SplitChangelogSentences(trimmedContent);
        break;
 
    case XmlParsedTags::kVersionTag:
        trimmedContent.Trim(true).Trim(false);
        mVersionPatch->version = VersionId::ParseFromString(trimmedContent);
        break;
 
    case XmlParsedTags::kLinkTag:
        trimmedContent.Trim(true).Trim(false);
        mVersionPatch->download = trimmedContent;
        break;
 
    default:
        break;
    }
}

References VersionPatch::changelog, VersionPatch::download, kDescriptionTag, kLinkTag, kVersionTag, mVersionPatch, mXmlParsingState, VersionId::ParseFromString(), SplitChangelogSentences(), and VersionPatch::version.

Here is the call graph for this function:

◆ HandleXMLEndTag()

void UpdateDataParser::HandleXMLEndTag ( const std::string_view & tag )

overrideprivate

Definition at line 122 of file UpdateDataParser.cpp.

{
    if (mXmlParsingState == XmlParsedTags::kDescriptionTag ||
        mXmlParsingState == XmlParsedTags::kLinkTag)
        mXmlParsingState = XmlParsedTags::kNotUsedTag;
 
    // If it is our working OS, using "kOsTag" for keeping ready for parse state for both tags:
    // <Version> and <Link>, that ordered one after another.
    if (mXmlParsingState == XmlParsedTags::kVersionTag)
        mXmlParsingState = XmlParsedTags::kOsTag;
}

References kDescriptionTag, kLinkTag, kNotUsedTag, kOsTag, kVersionTag, and mXmlParsingState.

◆ HandleXMLTag()

bool UpdateDataParser::HandleXMLTag	(	const std::string_view &	tag,
		const AttributesList &	attrs
	)

overrideprivatevirtual

Implements XMLTagHandler.

Definition at line 52 of file UpdateDataParser.cpp.

{
    if (tag == mXmlTagNames[XmlParsedTags::kDescriptionTag])
    {
        mXmlParsingState = XmlParsedTags::kDescriptionTag;
        return true;
    }
 
    const wxPlatformInfo& info = wxPlatformInfo::Get();
 
    constexpr bool is32Bit = sizeof(void*) == 4;
    constexpr bool is64Bit = sizeof(void*) == 8;
 
    if (is32Bit)
    {
       if (tag == mXmlTagNames[XmlParsedTags::kWin32Tag])
       {
          if (info.GetOperatingSystemId() & wxOS_WINDOWS)
             mXmlParsingState = XmlParsedTags::kOsTag;
          return true;
       }
    }
 
    if (is64Bit)
    {
       if (tag == mXmlTagNames[XmlParsedTags::kWin64Tag])
       {
          if (info.GetOperatingSystemId() & wxOS_WINDOWS)
             mXmlParsingState = XmlParsedTags::kOsTag;
          return true;
       }
    }
 
    if (tag == mXmlTagNames[XmlParsedTags::kMacosTag])
    {
        if (info.GetOperatingSystemId() & wxOS_MAC)
            mXmlParsingState = XmlParsedTags::kOsTag;
        return true;
    }
 
    if (tag == mXmlTagNames[XmlParsedTags::kLinuxTag])
    {
        if (info.GetOperatingSystemId() & wxOS_UNIX_LINUX)
            mXmlParsingState = XmlParsedTags::kOsTag;
        return true;
    }
 
    if (tag == mXmlTagNames[XmlParsedTags::kVersionTag])
    {
        if (mXmlParsingState == XmlParsedTags::kOsTag)
            mXmlParsingState = XmlParsedTags::kVersionTag;
        return true;
    }
 
    if (tag == mXmlTagNames[XmlParsedTags::kLinkTag])
    {
        if (mXmlParsingState == XmlParsedTags::kOsTag)
            mXmlParsingState = XmlParsedTags::kLinkTag;
        return true;
    }
 
    for (auto& xmlTag : mXmlTagNames)
    {
        if (tag == xmlTag.second)
            return true;
    }
 
    return false;
}

References BasicUI::Get(), kDescriptionTag, kLinkTag, kLinuxTag, kMacosTag, kOsTag, kVersionTag, kWin32Tag, kWin64Tag, mXmlParsingState, and mXmlTagNames.

Here is the call graph for this function:

◆ Parse()

bool UpdateDataParser::Parse	(	const VersionPatch::UpdateDataFormat &	updateData,
		VersionPatch *	versionPatch
	)

Parsing from update data format to VersionPatch fields.

Parameters

updateData	InputData.
versionPath	Parsed output data.

Returns: True if success.

Definition at line 22 of file UpdateDataParser.cpp.

{
    XMLFileReader xmlReader;
 
    ValueRestorer<VersionPatch*> setter{ mVersionPatch, versionPatch };
 
    return xmlReader.ParseString(this, updateData);
}

References mVersionPatch, and XMLFileReader::ParseString().

Referenced by UpdateManager::GetUpdates().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SplitChangelogSentences()

wxArrayString UpdateDataParser::SplitChangelogSentences ( const wxString & changelogContent )

private

Definition at line 31 of file UpdateDataParser.cpp.

{
    wxArrayString changelogSentenceList;
 
    size_t pos = 0;
    std::string s(changelogContent.ToStdString());
    std::string token;
    const std::string delimiter(". ");
 
    while ((pos = s.find(delimiter)) != std::string::npos)
    {
        token = s.substr(0, pos + 1);
        changelogSentenceList.Add(wxString(token).Trim());
 
        s.erase(0, pos + delimiter.length());
    }
    changelogSentenceList.Add(wxString(s).Trim());
 
    return changelogSentenceList;
}

References Tuple::detail::npos().

Referenced by HandleXMLContent().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mVersionPatch

VersionPatch* UpdateDataParser::mVersionPatch { nullptr }

private

Definition at line 68 of file UpdateDataParser.h.

Referenced by HandleXMLContent(), and Parse().

◆ mXmlParsingState

XmlParsedTags UpdateDataParser::mXmlParsingState { XmlParsedTags::kNotUsedTag }

private

Definition at line 46 of file UpdateDataParser.h.

Referenced by HandleXMLContent(), HandleXMLEndTag(), and HandleXMLTag().

◆ mXmlTagNames

std::map<XmlParsedTags, const char*> UpdateDataParser::mXmlTagNames

private

Initial value:

{
        { XmlParsedTags::kUpdateTag, "Updates" },
        { XmlParsedTags::kDescriptionTag, "Description" },
        { XmlParsedTags::kOsTag, "OS" },
        { XmlParsedTags::kWin32Tag, "Win32" },
        { XmlParsedTags::kWin64Tag, "Win64" },
        { XmlParsedTags::kMacosTag, "Macos" },
        { XmlParsedTags::kLinuxTag, "Linux" },
        { XmlParsedTags::kVersionTag, "Version" },
        { XmlParsedTags::kLinkTag, "Link" },
    }

Definition at line 48 of file UpdateDataParser.h.

Referenced by HandleXMLChild(), and HandleXMLTag().

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ XmlParsedTags

Constructor & Destructor Documentation

◆ UpdateDataParser()

◆ ~UpdateDataParser()

Member Function Documentation

◆ HandleXMLChild()

◆ HandleXMLContent()

◆ HandleXMLEndTag()

◆ HandleXMLTag()

◆ Parse()

◆ SplitChangelogSentences()

Member Data Documentation

◆ mVersionPatch

◆ mXmlParsingState

◆ mXmlTagNames