Documentation
Urho3D::FileSystem Class Reference
Subsystem for file and directory operations and access control. More...
#include <FileSystem.h>
Inheritance diagram for Urho3D::FileSystem:
Collaboration diagram for Urho3D::FileSystem:
Public Member Functions | |
| FileSystem (Context *context) | |
| Construct. | |
| ~FileSystem () | |
| 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. If it does not contain the Urho3D default CoreData and Data directories, and the current working directory does, return the working directory instead. More... | |
| String | GetUserDocumentsDir () const |
| Return the user documents directory. | |
| String | GetAppPreferencesDir (const String &org, const String &app) const |
| Return the application preferences directory. | |
 Public Member Functions inherited from Urho3D::Object | |
| Object (Context *context) | |
| Construct. | |
| virtual | ~Object () |
| Destruct. Clean up self from event sender & receiver structures. | |
| virtual Urho3D::StringHash | GetType () const =0 |
| Return type hash. | |
| virtual Urho3D::StringHash | GetBaseType () const =0 |
| Return base class type hash. | |
| virtual const Urho3D::String & | GetTypeName () const =0 |
| Return type name. | |
| virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event. | |
| 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 | 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 PODVector< 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. More... | |
| VariantMap & | GetEventDataMap () const |
| Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps. | |
| Context * | GetContext () const |
| Return execution context. | |
| Object * | GetSubsystem (StringHash type) const |
| Return subsystem by type. | |
| Object * | GetEventSender () const |
| Return active event sender. Null outside event handling. | |
| EventHandler * | GetEventHandler () 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 String & | GetCategory () const |
| Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. | |
| 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. | |
| 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. | |
| RefCount * | RefCountPtr () |
| Return pointer to the reference count structure. | |
Private Member Functions | |
| OBJECT (FileSystem) | |
| 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. More... | |
| void | HandleConsoleCommand (StringHash eventType, VariantMap &eventData) |
| Handle a console command event. | |
Private Attributes | |
| HashSet< String > | allowedPaths_ |
| Allowed directories. | |
| String | programDir_ |
| Cached program directory. | |
| List< AsyncExecRequest * > | asyncExecQueue_ |
| Async execution queue. | |
| unsigned | nextAsyncExecID_ |
| Next async execution ID. | |
| bool | executeConsoleCommands_ |
| Flag for executing engine console commands as OS-specific system command. Default to true. | |
Additional Inherited Members | |
| Protected Attributes inherited from Urho3D::Object | |
| Context * | context_ |
| Execution context. | |
Detailed Description
Subsystem for file and directory operations and access control.
Member Function Documentation
| String Urho3D::FileSystem::GetProgramDir | ( | ) | const |
Return the program's directory. If it does not contain the Urho3D default CoreData and Data directories, and the current working directory does, return the working directory instead.
- Todo:
- Should not rely on such fixed convention
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Handle begin frame event to check for completed async executions.
Go through the execution queue and post + remove completed requests
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Scan directory, called internally.
- Todo:
- Filename may be unnormalized Unicode on Mac OS X. Re-normalize as necessary
Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files:
- /home/travis/build/urho3d/Urho3D/Source/Urho3D/IO/FileSystem.h
- /home/travis/build/urho3d/Urho3D/Source/Urho3D/IO/FileSystem.cpp