Rebel Fork Framework
Urho3D::XMLFile Class Reference

XML document resource. More...

#include <Urho3D/Resource/XMLFile.h>

Inheritance diagram for Urho3D::XMLFile:
Urho3D::Resource Urho3D::Object Urho3D::RefCounted

Public Member Functions

 XMLFile (Context *context)
 ~XMLFile () override
bool BeginLoad (Deserializer &source) override
 Load resource from stream. May be called from a worker thread. Return true if successful.
bool Save (Serializer &dest) const override
 Save resource with default indentation (one tab). Return true if successful.
bool Save (Serializer &dest, const ea::string &indentation) const
 Save resource with user-defined indentation. Return true if successful.
bool FromString (const ea::string &source)
 Deserialize from a string. Return true if successful.
XMLElement CreateRoot (const ea::string &name)
 Clear the document and create a root element.
XMLElement GetOrCreateRoot (const ea::string &name)
 Get the root element if it has matching name, otherwise create it and clear the document.
XMLElement GetRoot (const ea::string &name=EMPTY_STRING) const
 Return the root element, with optionally specified name. Return null element if not found.
pugi::xml_document * GetDocument () const
 Return the pugixml document.
ea::string ToString (const ea::string &indentation="\t") const
 Serialize the XML content to a string.
void Patch (XMLFile *patchFile)
 Patch the XMLFile with another XMLFile. Based on RFC 5261.
void Patch (const XMLElement &patchElement)
 Patch the XMLFile with another XMLElement. Based on RFC 5261.
bool SaveObjectCallback (const ea::function< void(Archive &)> serializeValue)
bool LoadObjectCallback (const ea::function< void(Archive &)> serializeValue) const
template<class T , class ... Args>
bool SaveObject (const char *name, const T &object, Args &&... args)
template<class T , class ... Args>
bool LoadObject (const char *name, T &object, Args &&... args) const
bool SaveObject (const Object &object)
bool LoadObject (Object &object) const
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
bool Load (Deserializer &source)
 Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.
virtual bool EndLoad ()
 Finish resource loading. Always called from the main thread. Return true if successful.
bool LoadFile (const FileIdentifier &fileName)
 Load resource from file.
virtual bool SaveFile (const FileIdentifier &fileName) const
 Save resource to file.
void SetName (const ea::string &name)
void SetMemoryUse (unsigned size)
 Set memory use in bytes, possibly approximate.
void ResetUseTimer ()
 Reset last used timer.
void SetAsyncLoadState (AsyncLoadState newState)
 Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.
void SetAbsoluteFileName (const ea::string &fileName)
 Set absolute file name.
const ea::string & GetName () const
StringHash GetNameHash () const
 Return name hash.
unsigned GetMemoryUse () const
unsigned GetUseTimer ()
AsyncLoadState GetAsyncLoadState () const
 Return the asynchronous loading state.
const ea::string & GetAbsoluteFileName () const
 Return absolute file name.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
virtual const ea::string & GetTypeName () const =0
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
void SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T handler)
 Subscribe to a specific sender's event.
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
void UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void SendEvent (StringHash eventType, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
ContextGetContext () const
 Return execution context.
const VariantGetGlobalVar (StringHash key) const
const VariantMapGetGlobalVars () const
void SetGlobalVar (StringHash key, const Variant &value)
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
bool HasEventHandlers () const
 Return whether has subscribed to any event.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
const ea::string & GetCategory () const
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
int AddRef ()
int ReleaseRef ()
int Refs () const
int WeakRefs () const
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
bool IsScriptStrongRef () const
 Return true if script reference is strong.

Static Public Member Functions

static void RegisterObject (Context *context)
- Static Public Member Functions inherited from Urho3D::Resource
static ResourceLoadFromCache (Context *context, StringHash type, const ea::string &name)
 Load resource by reference.
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.

Private Member Functions

 URHO3D_OBJECT (XMLFile, Resource)
void PatchAdd (const pugi::xml_node &patch, pugi::xpath_node &original) const
 Add an node in the Patch.
void PatchReplace (const pugi::xml_node &patch, pugi::xpath_node &original) const
 Replace a node or attribute in the Patch.
void PatchRemove (const pugi::xpath_node &original) const
 Remove a node or attribute in the Patch.
void AddNode (const pugi::xml_node &patch, const pugi::xpath_node &original) const
 Add a node in the Patch.
void AddAttribute (const pugi::xml_node &patch, const pugi::xpath_node &original) const
 Add an attribute in the Patch.
bool CombineText (const pugi::xml_node &patch, const pugi::xml_node &original, bool prepend) const
 Combine two text nodes.

Private Attributes

ea::unique_ptr< pugi::xml_document > document_
 Pugixml document.

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.

Detailed Description

XML document resource.

Member Function Documentation

◆ RegisterObject()

void Urho3D::XMLFile::RegisterObject ( Context context)

Register object factory.

◆ SaveObjectCallback()

bool Urho3D::XMLFile::SaveObjectCallback ( const ea::function< void(Archive &)>  serializeValue)

Save/load objects using Archive serialization.

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