Urho3D
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Urho3D::FileSystem Class Reference

Subsystem for file and directory operations and access control. More...

#include </home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/IO/FileSystem.h>

Inheritance diagram for Urho3D::FileSystem:
Urho3D::Object Urho3D::RefCounted

Public Member Functions

 FileSystem (Context *context)
 Construct.
 
 ~FileSystem () override
 Destruct.
 
bool SetCurrentDir (const String &pathName)
 Set the current working directory.
 
bool CreateDir (const String &pathName)
 Create a directory.
 
void SetExecuteConsoleCommands (bool enable)
 Set whether to execute engine console commands as OS-specific system command.
 
int SystemCommand (const String &commandLine, bool redirectStdOutToLog=false)
 Run a program using the command interpreter, block until it exits and return the exit code. Will fail if any allowed paths are defined.
 
int SystemRun (const String &fileName, const Vector< String > &arguments)
 Run a specific program, block until it exits and return the exit code. Will fail if any allowed paths are defined.
 
unsigned SystemCommandAsync (const String &commandLine)
 Run a program using the command interpreter asynchronously. Return a request ID or M_MAX_UNSIGNED if failed. The exit code will be posted together with the request ID in an AsyncExecFinished event. Will fail if any allowed paths are defined.
 
unsigned SystemRunAsync (const String &fileName, const Vector< String > &arguments)
 Run a specific program asynchronously. Return a request ID or M_MAX_UNSIGNED if failed. The exit code will be posted together with the request ID in an AsyncExecFinished event. Will fail if any allowed paths are defined.
 
bool SystemOpen (const String &fileName, const String &mode=String::EMPTY)
 Open a file in an external program, with mode such as "edit" optionally specified. Will fail if any allowed paths are defined.
 
bool Copy (const String &srcFileName, const String &destFileName)
 Copy a file. Return true if successful.
 
bool Rename (const String &srcFileName, const String &destFileName)
 Rename a file. Return true if successful.
 
bool Delete (const String &fileName)
 Delete a file. Return true if successful.
 
void RegisterPath (const String &pathName)
 Register a path as allowed to access. If no paths are registered, all are allowed. Registering allowed paths is considered securing the Urho3D execution environment: running programs and opening files externally through the system will fail afterward.
 
bool SetLastModifiedTime (const String &fileName, unsigned newTime)
 Set a file's last modified time as seconds since 1.1.1970. Return true on success.
 
String GetCurrentDir () const
 Return the absolute current working directory.
 
bool GetExecuteConsoleCommands () const
 Return whether is executing engine console commands as OS-specific system command.
 
bool HasRegisteredPaths () const
 Return whether paths have been registered.
 
bool CheckAccess (const String &pathName) const
 Check if a path is allowed to be accessed. If no paths are registered, all are allowed.
 
unsigned GetLastModifiedTime (const String &fileName) const
 Returns the file's last modified time as seconds since 1.1.1970, or 0 if can not be accessed.
 
bool FileExists (const String &fileName) const
 Check if a file exists.
 
bool DirExists (const String &pathName) const
 Check if a directory exists.
 
void ScanDir (Vector< String > &result, const String &pathName, const String &filter, unsigned flags, bool recursive) const
 Scan a directory for specified files.
 
String GetProgramDir () const
 Return the program's directory.
 
String GetUserDocumentsDir () const
 Return the user documents directory.
 
String GetAppPreferencesDir (const String &org, const String &app) const
 Return the application preferences directory.
 
String GetTemporaryDir () const
 Return path of temporary directory. Path always ends with a forward slash.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash. More...
 
virtual const StringGetTypeName () const =0
 Return type name. More...
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
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 SubscribeToEvent (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
void SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 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 Vector< StringHash > &exceptions, bool onlyUserData)
 Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events).
 
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, Args... args)
 Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
 
const VariantMapGetGlobalVars () const
 Return all global variables.
 
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and 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 StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
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.
 
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
 
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
 
int Refs () const
 Return reference count.
 
int WeakRefs () const
 Return weak reference count.
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 

Private Member Functions

 URHO3D_OBJECT (FileSystem, Object)
 
void ScanDirInternal (Vector< String > &result, String path, const String &startPath, const String &filter, unsigned flags, bool recursive) const
 Scan directory, called internally. More...
 
void HandleBeginFrame (StringHash eventType, VariantMap &eventData)
 Handle begin frame event to check for completed async executions.
 
void HandleConsoleCommand (StringHash eventType, VariantMap &eventData)
 Handle a console command event.
 

Private Attributes

HashSet< StringallowedPaths_
 Allowed directories.
 
List< AsyncExecRequest * > asyncExecQueue_
 Async execution queue.
 
unsigned nextAsyncExecID_ {1}
 Next async execution ID.
 
bool executeConsoleCommands_ {}
 Flag for executing engine console commands as OS-specific system command. Default to true.
 

Additional Inherited Members

- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.
 

Detailed Description

Subsystem for file and directory operations and access control.

Member Function Documentation

◆ ScanDirInternal()

void Urho3D::FileSystem::ScanDirInternal ( Vector< String > &  result,
String  path,
const String startPath,
const String filter,
unsigned  flags,
bool  recursive 
) const
private

Scan directory, called internally.

Todo:
Filename may be unnormalized Unicode on Mac OS X. Re-normalize as necessary

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