XmlFile.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/StringFwd.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "XmlNode.h"
 
class FXmlAttribute;
class FXmlNode;
 
namespace EConstructMethod
{
    enum Type
    {
        ConstructFromFile,
        ConstructFromBuffer,
    };
}
 
class FXmlFile
{
public:
 
    FXmlFile() : RootNode(nullptr), bFileLoaded(false) {}
    XMLPARSER_API FXmlFile(const FString& InFile, EConstructMethod::Type ConstructMethod = EConstructMethod::ConstructFromFile);
    ~FXmlFile() { Clear(); };
 
    FXmlFile(const FXmlFile& rhs) = delete;
    FXmlFile& operator=(const FXmlFile& rhs) = delete;
 
    XMLPARSER_API bool LoadFile(const FString& Path, EConstructMethod::Type ConstructMethod = EConstructMethod::ConstructFromFile);
    XMLPARSER_API FString GetLastError() const;
    XMLPARSER_API void Clear();
    XMLPARSER_API bool IsValid() const;
 
    XMLPARSER_API const FXmlNode* GetRootNode() const;
 
    XMLPARSER_API FXmlNode* GetRootNode();
 
    XMLPARSER_API bool Save(const FString& Path);
 
    XMLPARSER_API void EnableAttemptToPreserveWhitespaceHack();
 
private:
 
    XMLPARSER_API void PreProcessInput(TArray<FString>& Input);
    XMLPARSER_API void WhiteOut(TArray<FString>& Input, int32 LineStart, int32 LineEnd, int32 IndexStart, int32 IndexEnd);
    XMLPARSER_API void Tokenize(FStringView Input, TArray<FString>& Tokens);
    XMLPARSER_API TArray<FString> Tokenize(const TArray<FString>& Input);
    static XMLPARSER_API void AddAttribute(const FString& InToken, TArray<FXmlAttribute>& OutAttributes);
    XMLPARSER_API FXmlNode* CreateRootNode(TArrayView<const FString> Tokens);
    XMLPARSER_API void HookUpNextPtrs(FXmlNode* Node);
    XMLPARSER_API void CreateNodes(const TArray<FString>& Tokens);
    static XMLPARSER_API void WriteNodeHierarchy(const FXmlNode& Node, const FString& Indent, FString& Output);
 
private:
 
    FString LoadedFile;
    FString ErrorMessage;
    FXmlNode* RootNode;
    bool bFileLoaded;
    bool bCreationFailed;
 
    bool bHackAttemptToPreserveWhitespace = false;
};