Class: etk::FSNode

Synopsis:

+                              FSNode                   (const std::string & _path);
+                              FSNode                   (const std::u32string & _path);
+                             ~FSNode                   (void);
+  bool                        exist                    (void);
+  etk::FSNodeRight            getRight                 (void);
+  bool                        setRight                 (etk::FSNodeRight _newRight);
+  void                        setName                  (const std::string & _newName);
+  void                        setName                  (const std::u32string & _newName);
+  std::string                 getFileSystemName        (void);
+  std::u32string              getUFileSystemName       (void);
+  std::string                 getNameFolder            (void);
+  std::u32string              getUNameFolder           (void);
+  std::string                 getName                  (void);
+  std::u32string              getUName                 (void);
+  std::string                 getNameFile              (void);
+  std::u32string              getUNameFile             (void);
+  std::string                 getRelativeFolder        (void);
+  std::u32string              getURelativeFolder       (void);
+  bool                        touch                    (void);
+  bool                        move                     (const std::string & _path);
+  bool                        move                     (const std::u32string & _path);
+  bool                        remove                   (void);
+  uint64_t                    timeCreated              (void);
+  std::string                 timeCreatedString        (void);
+  std::u32string              timeUCreatedString       (void);
+  uint64_t                    timeModified             (void);
+  std::string                 timeModifiedString       (void);
+  std::u32string              timeUModifiedString      (void);
+  uint64_t                    timeAccessed             (void);
+  std::string                 timeAccessedString       (void);
+  std::u32string              timeUAccessedString      (void);
+  const etk::FSNode &         operator=                (const etk::FSNode & _obj);
+  bool                        operator==               (const etk::FSNode & _obj);
+  bool                        operator!=               (const etk::FSNode & _obj);
+  friend etk::CCout &         operator<<               (etk::CCout & _os,
                                                         const etk::FSNode & _obj);
+  int64_t                     folderCount              (void);
+  std::vector  folderGetSubList         (bool _showHidenFile,
                                                         bool _getFolderAndOther,
                                                         bool _getFile,
                                                         bool _temporaryFile);
+  etk::FSNode                 folderGetParent          (void);
+  void                        folderGetRecursiveFiles  (std::vector & _output,
                                                         bool _recursiveEnable);
+  void                        folderGetRecursiveFiles  (std::vector & _output,
                                                         bool _recursiveEnable);
+  bool                        fileHasExtention         (void);
+  std::string                 fileGetExtention         (void);
+  std::u32string              fileUGetExtention        (void);
+  uint64_t                    fileSize                 (void);
+  bool                        fileOpenRead             (void);
+  bool                        fileOpenWrite            (void);
+  bool                        fileOpenAppend           (void);
+  bool                        fileClose                (void);
+  char *                      fileGets                 (char * _elementLine,
                                                         int64_t _maxData);
+  char                        fileGet                  (void);
+  int64_t                     fileRead                 (void * _data,
                                                         int64_t _blockSize,
                                                         int64_t _nbBlock);
+  int64_t                     fileWrite                (void * _data,
                                                         int64_t _blockSize,
                                                         int64_t _nbBlock);
+  bool                        fileSeek                 (long int _offset,
                                                         enum etk::seekNode _origin);
+  void                        fileFlush                (void);
-  void                        generateFileSystemPath   (void);
-  void                        updateFileSystemProperty (void);
-  void                        privateSetName           (const std::string & _newName);
-  void                        privateSetName           (const std::u32string & _newName);
-  bool                        loadDataZip              (void);
-  void                        sortElementList          (std::vector & _list);

Description:

/** * @brief FS node is for File system IO access This class is independent of the OS, If you acces to a file in windows, it might generate the right loke Linux (it is important to know that windows right is lighter than linux) */

Detail:

etk::FSNode ()

FSNode(const std::string & _path);

Constructor

Parameter [input]: _path Path of the curent file /folder ...

---

etk::FSNode ()

FSNode(const std::u32string & _path);

---

etk::~FSNode ()

~FSNode(void);

Destructor
Notes: you will have some warning if you did not close your files

---

exist ()

bool exist(void);

Check if the node exist.

Return: true : The node existed.
Return: false : The node does not exist.

---

getRight ()

etk::FSNodeRight getRight(void);

Get the node Right

Return: the requested right

---

setRight ()

bool setRight(etk::FSNodeRight _newRight);

Set the specific right of the node

Parameter [input]: _newRight new right to set
Return: true : action done
Return: false : action not done

---

setName ()

void setName(const std::string & _newName);

Change the Node seeing (not rename the node, for this

Parameter [input]: _newName New node name to show
Return: true : action done
Return: false : action not done

---

setName ()

void setName(const std::u32string & _newName);

---

getFileSystemName ()

std::string getFileSystemName(void);

Get the Generate FileSystem name

Return: the requested filename

---

getUFileSystemName ()

std::u32string getUFileSystemName(void);

---

getNameFolder ()

std::string getNameFolder(void);

Get the current folder of the Node. (file system name)
Notes: Auto remove of ../../../ and //

Return: the common name define (like /xxxxx/xxxxx/ or c:/xxxxx/xxxxx/)

---

getUNameFolder ()

std::u32string getUNameFolder(void);

---

getName ()

std::string getName(void);

Get the current compleate node name (file system name)
Notes: Auto remove of ../../../ and //

Return: All the user name definition (like /xxxxx/xxxxx/myFile.kkk or c:/xxxxx/xxxxx/myFile.kkk)

---

getUName ()

std::u32string getUName(void);

---

getNameFile ()

std::string getNameFile(void);

Get the file or current file name (if it was a file)

Return: the name of the node (like myFile.kkk)

---

getUNameFile ()

std::u32string getUNameFile(void);

---

getRelativeFolder ()

std::string getRelativeFolder(void);

Get the current folder of the Node.
Notes: Auto remove of ../../../ and //

Return: the common name define (like DATA:xxxxx/xxxxx/)

---

getURelativeFolder ()

std::u32string getURelativeFolder(void);

---

touch ()

bool touch(void);

update the Time of the file with the current time

Return: true : action done
Return: false : action not done

---

move ()

bool move(const std::string & _path);

Move the Node at a new path

Parameter [input]: _path The new path
Return: true : action done
Return: false : action not done

---

move ()

bool move(const std::u32string & _path);

---

remove ()

bool remove(void);

Remove the current node ( if folder, this remove all subfolder but not the Link subfolder)

Return: true : action done
Return: false : action not done

---

timeCreated ()

uint64_t timeCreated(void);

Get the creating time of the File

Return: The time requested

---

timeCreatedString ()

std::string timeCreatedString(void);

Get the creating time of the File

Return: The time requested (in string)

---

timeUCreatedString ()

std::u32string timeUCreatedString(void);

---

timeModified ()

uint64_t timeModified(void);

Get the modifying time of the File

Return: The time requested

---

timeModifiedString ()

std::string timeModifiedString(void);

Get the modifying time of the File

Return: The time requested (in string)

---

timeUModifiedString ()

std::u32string timeUModifiedString(void);

---

timeAccessed ()

uint64_t timeAccessed(void);

Get the Accessed time of the File

Return: The time requested

---

timeAccessedString ()

std::string timeAccessedString(void);

Get the Accessed time of the File

Return: The time requested (in string)

---

timeUAccessedString ()

std::u32string timeUAccessedString(void);

---

operator= ()

const etk::FSNode & operator=(const etk::FSNode & _obj);

copy the other FSnode ==> for vector

Parameter [input]: _obj input node
Return: the current modify node

---

operator== ()

bool operator==(const etk::FSNode & _obj);

Check if the 2 node are link with the same file

Parameter [input]: _obj input node
Return: true : same node, false otherwise

---

operator!= ()

bool operator!=(const etk::FSNode & _obj);

Check if the 2 node are NOT link with the same file

Parameter [input]: _obj input node
Return: false : same node, true otherwise

---

operator<< ()

friend etk::CCout & operator<<(etk::CCout & _os,
                               const etk::FSNode & _obj);

Write in the statard debug IO the current node

Parameter [input]: _os std debug IO
Parameter [input]: _obj Node to display
Return: std debug IO

---

folderCount ()

int64_t folderCount(void);

Count the number of subFolder in the curent Folder

Return: >=0 nb of subElement
Return: -1 an error occured ==> not a folder ???

---

folderGetSubList ()

std::vector folderGetSubList(bool _showHidenFile,
                                            bool _getFolderAndOther,
                                            bool _getFile,
                                            bool _temporaryFile);

Get the List of all node inside a node (folder only)

Parameter [input]: _showHidenFile Add hidden file/folder/...
Parameter [input]: _getFolderAndOther get folder
Parameter [input]: _getFile Get files
Parameter [input]: _temporaryFile add Tmp file like .bck or ~
Return: The requested list

---

folderGetParent ()

etk::FSNode folderGetParent(void);

Get the father node of this node

Return: The requested node

---

folderGetRecursiveFiles ()

void folderGetRecursiveFiles(std::vector & _output,
                             bool _recursiveEnable);

Get all the File inside a Folder (done recursively)

Parameter [output]: _output List of all the File names (You must clear it before set it in)
Parameter [input]: _recursiveEnable Activate the recursive mode (enable by default)

---

folderGetRecursiveFiles ()

void folderGetRecursiveFiles(std::vector & _output,
                             bool _recursiveEnable);

---

fileHasExtention ()

bool fileHasExtention(void);

Check if the file have an extention ( ***.ccc)

Return: true The file have an extention.
Return: false The file have NO extention.

---

fileGetExtention ()

std::string fileGetExtention(void);

Get the extention of the Node

Return: the requested extention

---

fileUGetExtention ()

std::u32string fileUGetExtention(void);

---

fileSize ()

uint64_t fileSize(void);

Get the File size

Return: the requested size

---

fileOpenRead ()

bool fileOpenRead(void);

Open the file in Read mode

Return: true : action done
Return: false : action not done

---

fileOpenWrite ()

bool fileOpenWrite(void);

Open the file in write Mode
Notes: You can not do it with the DATA: file ==> this is not allowed in some Board like Android)

Return: true : action done
Return: false : action not done

---

fileOpenAppend ()

bool fileOpenAppend(void);

Open the file in write Append Mode
Notes: You can not do it with the DATA: file ==> this is not allowed in some Board like Android)

Return: true : action done
Return: false : action not done

---

fileClose ()

bool fileClose(void);

Close the cuurent file

Return: true : action done
Return: false : action not done

---

fileGets ()

char * fileGets(char * _elementLine,
                int64_t _maxData);

Get the pointer on the start line and the next line (or null)

Parameter [input] [output]: _elementLine Pointer to an array of chars where the string read is copied.
Parameter [input]: _maxData Maximum number of characters to be copied into str (including the terminating null-character).
Return: the pointer on the end of the cuurent line.

---

fileGet ()

char fileGet(void);

Get a unique data in the file

Return: the next element in the file.

---

fileRead ()

int64_t fileRead(void * _data,
                 int64_t _blockSize,
                 int64_t _nbBlock);

Read data from the file

Parameter [input] [output]: _data Pointer on the buffer that might be set the data
Parameter [input]: _blockSize Size of one block of data
Parameter [input]: _nbBlock Number of block needed
Return: Number of element read (in block number)

---

fileWrite ()

int64_t fileWrite(void * _data,
                  int64_t _blockSize,
                  int64_t _nbBlock);

Write data on the file

Parameter [input]: _data Pointer on the buffer that might be set on the file
Parameter [input]: _blockSize Size of one block of data
Parameter [input]: _nbBlock Number of block needed
Return: Number of element written (in block number)

---

fileSeek ()

bool fileSeek(long int _offset,
              enum etk::seekNode _origin);

Move in the file Position

Parameter [input]: _offset Offset to apply at the file
Parameter [input]: _origin Origin of the position
Return: true : action done
Return: false : action not done

---

fileFlush ()

void fileFlush(void);

Flush the current file

---

generateFileSystemPath ()

void generateFileSystemPath(void);

Internal methode that create the internal Real system name (transform DATA: HOME: DATA:GUI: in the real name of the files)

---

updateFileSystemProperty ()

void updateFileSystemProperty(void);

Update the internal data of the right type, and times

---

privateSetName ()

void privateSetName(const std::string & _newName);

Common set name of the Node (if the user decide to change the node selection

Parameter [input]: _newName Name of the Node

---

privateSetName ()

void privateSetName(const std::u32string & _newName);

---

loadDataZip ()

bool loadDataZip(void);

Explocitly for Android that data are stored in the .apk that is a .zip not compressed

Return: true : Load is OK
Return: false : An error Occured

---

sortElementList ()

void sortElementList(std::vector & _list);

Order the list of subnode the folder first and the alphabetical order

Parameter [input] [output]: _list The list to order

---