Kigs Framework  Doc version 0.8
Open source multi purpose Rapid Application Development framework
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
FilePathManager Class Reference
Inheritance diagram for FilePathManager:
CoreModifiable GenericRefCountedBaseClass

Public Member Functions

 FilePathManager (const std::string &name, DECLARE_CLASS_NAME_TREE_ARG)
 constructor
 
void AddToPath (const std::string &path, std::string ext="*", DeviceID deviceID=RESSOURCES)
 add a path to the current PATH for the given extension More...
 
void RemoveFromPath (const std::string &path, std::string ext="*", DeviceID deviceID=RESSOURCES)
 remove from path

 
void InitBundleList (const std::string &filename)
 init bundle list
 
void InitBundleRoot (const std::string &root)
 init bundle root
 
void InitWithConfigFile (const std::string &filename)
 init from config json file
 
SmartPointer< FileHandle > FindFullName (const std::string &filename)
 find the fullPath for the given file More...
 
std::string PreferedPath (const std::string &filename)
 construct the "prefered path" according to filename extension
 
void Clear ()
 clear all pathes More...
 
std::string GetPathString ()
 return the full path, seperate by ";"
 
- Public Member Functions inherited from CoreModifiable
void Init ()
 Modifiable managmenent.
 
void EmptyItemList ()
 remove all items (sons)
 
CMSP GetInstanceByPath (const std::string &path)
 return the instance corresponding to the given path in sons tree
 
std::string GetRuntimeID () const
 ID.
 
CoreModifiableAttributegetAttribute (KigsID labelid) const
 Attribute management.
 
u32 getNbArrayElements (KigsID attributeLabel) const
 return element count for an array type attribute
 
template<typename attribute_type , typename value_type >
attribute_type * AddDynamicAttribute (KigsID ID, const value_type &value)
 Dynamic attribute management.
 
const kigs::unordered_map< KigsID, ModifiableMethodStruct > * GetMethods ()
 Method management.
 
bool aggregateWith (CMSP &item, ItemPosition pos=Last)
 Aggregate management.
 
void flagAsNotificationCenterRegistered ()
 Flags.
 
void InitParametersFromList (const std::vector< CoreModifiableAttribute * > *params)
 Utility. More...
 
virtual void InitModifiable ()
 default modifiable init : set all initparams to readonly and set initflag to true More...
 
virtual void UninitModifiable ()
 called when InitModifiable has failled : reset read/write flag on all init params More...
 
virtual void ProtectedDestroy ()
 Destroy method decrement refcounter and delete instance if no more used. More...
 
virtual void addUser (CoreModifiable *user)
 add the given parent to list
 
virtual void removeUser (CoreModifiable *user)
 remove user (parent)
 
virtual bool addItem (const CMSP &item, ItemPosition pos=Last)
 add item at first or last position
 
virtual bool removeItem (const CMSP &item)
 remove item (son)
 

Static Public Member Functions

static std::string DevicePath (const std::string &filename, DeviceID)
 construct path according to device
 
- Static Public Member Functions inherited from CoreModifiable
static std::vector< CMSP > GetRootInstances (const KigsID &cid, bool exactTypeOnly=false)
 static method : return the set of all root instances of the given type
 
static void Append (std::string &XMLString, const std::list< CoreModifiable * > &toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the several CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static void Export (const std::string &filename, CoreModifiable *toexport, bool recursive=false, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static XMLNodeExportToXMLNode (CoreModifiable *toexport, XML *owner_xml_file, bool recursive, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML Node. if recursive flag is set to true, export also all sons tree More...
 
static std::string ExportToXMLString (CoreModifiable *toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static void Export (std::string &XMLString, const std::list< CoreModifiable * > &toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the several CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static CMSP Import (const std::string &filename, bool noInit=false, bool keepImportFileName=false, ImportState *state=nullptr, const std::string &override_name="")
 return an new CoreModifiable instance using the description found in XML file given by name
 
static CMSP GetInstanceByGlobalPath (const std::string &path)
 static method : return the instance corresponding to the given path, and given search start
 
static void debugPrintfFullTree (int maxindent=3)
 Editor. More...
 

Protected Member Functions

virtual ~FilePathManager ()
 destructor
 
- Protected Member Functions inherited from CoreModifiable
void UpdateAggregates (const Timer &timer, void *addParam)
 Internals.
 
void Export (std::vector< CoreModifiable * > &savedList, XMLNode *currentNode, bool recursive, ExportSettings *settings)
 Export. More...
 
CoreModifiableAttributeGenericCreateDynamicAttribute (CoreModifiable::ATTRIBUTE_TYPE type, KigsID ID)
 create and add dynamic attribute except arrays
 

Static Protected Member Functions

static std::string GetDevicePathString (DeviceID)
 the returned string will be added at start of the path to be retreived easily by fopen
 
- Static Protected Member Functions inherited from CoreModifiable
template<typename StringType >
static CMSP Import (XMLNodeTemplate< StringType > *currentNode, CoreModifiable *currentModifiable, ImportState &importState)
 recusrive method to add sons and attributes found in the XML file
 

Protected Attributes

kigs::unordered_map< std::string, std::vector< std::string > > mPath
 For each extension, a path list.
 

Friends

class CorePackage
 

Detailed Description

Attributes

Key : StrictPath

Member Function Documentation

◆ AddToPath()

void FilePathManager::AddToPath ( const std::string &  path,
std::string  ext = "*",
DeviceID  deviceID = RESSOURCES 
)

add a path to the current PATH for the given extension

add a new path for the given extension if extension is "*", then add the path to all current extension

◆ Clear()

void FilePathManager::Clear ( )

clear all pathes

clear all pathes and all struct before destroying the instance

◆ FindFullName()

SmartPointer< FileHandle > FilePathManager::FindFullName ( const std::string &  filename)

find the fullPath for the given file

search the given file in the pathes corresponding to its extension, or in the "all extension" * path and if found return the full filename with path


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