From 53a41382f5500fbe0834e07db5c95aa8a0c70316 Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Sat, 18 Oct 2014 09:21:19 +0200 Subject: [PATCH] [DOC] update doc --- class_etk__Archive.html | 52 +- class_etk__Archive__Content.html | 36 +- class_etk__BaseNoise.html | 14 +- class_etk__Buffer.html | 56 +- class_etk__CCout.html | 202 ------- class_etk__CEndl.html | 65 --- class_etk__CStart.html | 65 --- class_etk__Color.html | 283 ---------- ...olor__template_MY_TYPE_MY_TYPE_SIZE__.html | 279 ++++++++++ class_etk__FSNode.html | 277 ++++++---- class_etk__FSNodeRight.html | 86 +-- ...> class_etk__Fifo__template_MY_TYPE__.html | 32 +- ...ass_etk__HashData__template_MY_TYPE__.html | 18 +- ...> class_etk__Hash__template_MY_TYPE__.html | 53 +- class_etk__Matrix4.html | 68 +-- ...ml => class_etk__Matrix__template_T__.html | 58 +- class_etk__Mutex.html | 105 ---- class_etk__Noise.html | 14 +- class_etk__Plane.html | 183 ------- class_etk__Plane__template_T__.html | 179 +++++++ class_etk__RegExp.html | 207 -------- class_etk__RegExpNode.html | 169 ------ class_etk__RegExpNodeBracket.html | 126 ----- class_etk__RegExpNodeDigit.html | 110 ---- class_etk__RegExpNodeDigitNot.html | 110 ---- class_etk__RegExpNodeDot.html | 110 ---- class_etk__RegExpNodeEOL.html | 110 ---- class_etk__RegExpNodeLetter.html | 110 ---- class_etk__RegExpNodeLetterNot.html | 110 ---- class_etk__RegExpNodePThese.html | 131 ----- class_etk__RegExpNodePTheseElem.html | 126 ----- class_etk__RegExpNodeSOL.html | 110 ---- class_etk__RegExpNodeValue.html | 129 ----- class_etk__RegExpNodeWhiteSpace.html | 110 ---- class_etk__RegExpNodeWhiteSpaceNot.html | 110 ---- class_etk__RegExpNodeWordChar.html | 110 ---- class_etk__RegExpNodeWordCharNot.html | 110 ---- class_etk__Semaphore.html | 122 ----- class_etk__Vector2D.html | 427 --------------- class_etk__Vector2D__template_T__.html | 435 +++++++++++++++ class_etk__Vector3D.html | 435 --------------- class_etk__Vector3D__template_T__.html | 395 ++++++++++++++ ... => class_etk__Vector4D__template_T__.html | 102 ++-- class_etk__archive__Zip.html | 16 +- class_etk__elementPos_ts.html | 87 --- class_utf8__iterator.html | 299 +++++++++++ enum_etk__FSNType.html | 4 +- enum_etk__Noise__noise.html | 4 +- ...logLevel.html => enum_etk__log__level.html | 6 +- enum_etk__regExpPrivateSection.html | 161 ------ enum_etk__seekNode.html | 4 +- enum_etk__typeNode.html | 4 +- index.html | 22 +- library_etk.html | 48 +- namespace_debug.html | 91 ---- namespace_etk.html | 501 +++++++++++++----- namespace_etk__archive.html | 4 +- namespace_etk__color.html | 302 +++++------ namespace_etk__log.html | 192 +++++++ namespace_etk__theme.html | 49 +- namespace_etk__tool.html | 32 +- namespace_std.html | 117 ++-- namespace_u32char.html | 40 +- namespace_utf8.html | 21 +- struct_etk__.html | 90 ---- 65 files changed, 2942 insertions(+), 5291 deletions(-) delete mode 100644 class_etk__CCout.html delete mode 100644 class_etk__CEndl.html delete mode 100644 class_etk__CStart.html delete mode 100644 class_etk__Color.html create mode 100644 class_etk__Color__template_MY_TYPE_MY_TYPE_SIZE__.html rename class_etk__Fifo.html => class_etk__Fifo__template_MY_TYPE__.html (68%) rename class_etk__HashData.html => class_etk__HashData__template_MY_TYPE__.html (79%) rename class_etk__Hash.html => class_etk__Hash__template_MY_TYPE__.html (66%) rename class_etk__Matrix.html => class_etk__Matrix__template_T__.html (54%) delete mode 100644 class_etk__Mutex.html delete mode 100644 class_etk__Plane.html create mode 100644 class_etk__Plane__template_T__.html delete mode 100644 class_etk__RegExp.html delete mode 100644 class_etk__RegExpNode.html delete mode 100644 class_etk__RegExpNodeBracket.html delete mode 100644 class_etk__RegExpNodeDigit.html delete mode 100644 class_etk__RegExpNodeDigitNot.html delete mode 100644 class_etk__RegExpNodeDot.html delete mode 100644 class_etk__RegExpNodeEOL.html delete mode 100644 class_etk__RegExpNodeLetter.html delete mode 100644 class_etk__RegExpNodeLetterNot.html delete mode 100644 class_etk__RegExpNodePThese.html delete mode 100644 class_etk__RegExpNodePTheseElem.html delete mode 100644 class_etk__RegExpNodeSOL.html delete mode 100644 class_etk__RegExpNodeValue.html delete mode 100644 class_etk__RegExpNodeWhiteSpace.html delete mode 100644 class_etk__RegExpNodeWhiteSpaceNot.html delete mode 100644 class_etk__RegExpNodeWordChar.html delete mode 100644 class_etk__RegExpNodeWordCharNot.html delete mode 100644 class_etk__Semaphore.html delete mode 100644 class_etk__Vector2D.html create mode 100644 class_etk__Vector2D__template_T__.html delete mode 100644 class_etk__Vector3D.html create mode 100644 class_etk__Vector3D__template_T__.html rename class_etk__Vector4D.html => class_etk__Vector4D__template_T__.html (58%) delete mode 100644 class_etk__elementPos_ts.html create mode 100644 class_utf8__iterator.html rename enum_etk__logLevel.html => enum_etk__log__level.html (97%) delete mode 100644 enum_etk__regExpPrivateSection.html delete mode 100644 namespace_debug.html create mode 100644 namespace_etk__log.html delete mode 100644 struct_etk__.html diff --git a/class_etk__Archive.html b/class_etk__Archive.html index d1b5c8f..4b8f62c 100644 --- a/class_etk__Archive.html +++ b/class_etk__Archive.html @@ -15,6 +15,8 @@

Constructor and Destructor:

-+                             Archive     (const std::string & _fileName);
+ virtual                     ~Archive    (void );
++ Archive (const std::string & _fileName);
+ virtual ~Archive ();

Synopsis:

-#         std::string         m_fileName;
+         const std::string & getFileName (void );
#         etk::Hash<Content>  m_content;
+         int32_t             size        (void ) const;
+         const std::string & getName     (int32_t _id) const;
+         const Content &     getContent  (int32_t _id) const;
+         const Content &     getContent  (const std::string & _key) const;
+         bool                exist       (const std::string & _key) const;
+         void                open        (const std::string & _key);
+         void                close       (const std::string & _key);
+         void                display     (void );
# virtual void                loadFile    (int32_t _id);
+         Archive*            load        (const std::string & _fileName);
+# std::string m_fileName;
+ const std::string & getFileName ();
# std::map<std::string,Content> m_content;
+ int32_t size () const;
+ const std::string & getName (size_t _id) const;
+ const Content & getContent (size_t _id) const;
+ const Content & getContent (const std::string & _key) const;
+ bool exist (const std::string & _key) const;
+ void open (const std::string & _key);
+ void close (const std::string & _key);
+ void display ();
# virtual void loadFile (const std::map ,
Content>::iterator & it);
+ Archive* load (const std::string & _fileName);

Object Hierarchy:

 etk::Archive
  +--> etk::archive::Zip

Detail:

-

Archive

+
Archive
 +  Archive (const std::string & _fileName);

 
 

 

 

-
~Archive
-+ virtual  ~Archive (void );

+
~Archive
++ virtual  ~Archive ();

 
 

 

 

-
m_fileName
+
m_fileName
 # std::string m_fileName;

 
 File name when it came from an file

 

 

-
getFileName
-+ const std::string & getFileName (void );

+
getFileName
++ const std::string & getFileName ();

 Get the current file name.

 

 
Synopsis:

 
-+ bool                         exist                    (void ) const;
+ enum typeNode                getNodeType              (void ) const;
+ etk::FSNodeRight             getRight                 (void ) const;
+ bool                         setRight                 (etk::FSNodeRight _newRight);
+ void                         setName                  (const std::string & _newName);
+ void                         setName                  (const std::u32string & _newName);
+ std::string                  getFileSystemName        (void ) const;
+ std::u32string               getUFileSystemName       (void ) const;
+ std::string                  getNameFolder            (void ) const;
+ std::u32string               getUNameFolder           (void ) const;
+ std::string                  getName                  (void ) const;
+ std::u32string               getUName                 (void ) const;
+ std::string                  getNameFile              (void ) const;
+ std::u32string               getUNameFile             (void ) const;
+ std::string                  getRelativeFolder        (void ) const;
+ std::u32string               getURelativeFolder       (void ) const;
+ bool                         touch                    (void );
+ bool                         move                     (const std::string & _path);
+ bool                         move                     (const std::u32string & _path);
+ enum FSNType                 getTypeAccess            (void ) const;
+ bool                         remove                   (void );
+ uint64_t                     timeCreated              (void ) const;
+ std::string                  timeCreatedString        (void ) const;
+ std::u32string               timeUCreatedString       (void ) const;
+ uint64_t                     timeModified             (void ) const;
+ std::string                  timeModifiedString       (void ) const;
+ std::u32string               timeUModifiedString      (void ) const;
+ uint64_t                     timeAccessed             (void ) const;
+ std::string                  timeAccessedString       (void ) const;
+ std::u32string               timeUAccessedString      (void ) const;
+ const etk::FSNode &          operator =               (const etk::FSNode & _obj);
+ bool                         operator ==              (const etk::FSNode & _obj) const;
+ bool                         operator !=              (const etk::FSNode & _obj) const;
+ friendetk::CCout &           operator <<              (etk::CCout & _os,
                                                         const etk::FSNode & _obj);
+ int64_t                      folderCount              (void );
+ std::vector<etk::FSNode*>    folderGetSubList         (bool _showHidenFile,
                                                         bool _getFolderAndOther,
                                                         bool _getFile,
                                                         bool _temporaryFile);
+ etk::FSNode                  folderGetParent          (void );
+ void                         folderGetRecursiveFiles  (std::vector<std::string> & _output,
                                                         bool _recursiveEnable);
+ void                         folderGetRecursiveFiles  (std::vector<std::u32string> & _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                 (longint _offset,
                                                         enum etk::seekNode _origin);
+ void                         fileFlush                (void );

++ bool                         exist                    () const;
+ enum typeNode                getNodeType              () const;
+ etk::FSNodeRight             getRight                 () const;
+ bool                         setRight                 (etk::FSNodeRight _newRight);
+ void                         setName                  (const std::string & _newName);
+ void                         setName                  (const std::u32string & _newName);
+ std::string                  getFileSystemName        () const;
+ std::u32string               getUFileSystemName       () const;
+ std::string                  getNameFolder            () const;
+ std::u32string               getUNameFolder           () const;
+ std::string                  getName                  () const;
+ std::u32string               getUName                 () const;
+ std::string                  getNameFile              () const;
+ std::u32string               getUNameFile             () const;
+ std::string                  getRelativeFolder        () const;
+ std::u32string               getURelativeFolder       () const;
+ bool                         touch                    ();
+ bool                         move                     (const std::string & _path);
+ bool                         move                     (const std::u32string & _path);
+ enum FSNType                 getTypeAccess            () const;
+ bool                         remove                   ();
+ uint64_t                     timeCreated              () const;
+ std::string                  timeCreatedString        () const;
+ std::u32string               timeUCreatedString       () const;
+ uint64_t                     timeModified             () const;
+ std::string                  timeModifiedString       () const;
+ std::u32string               timeUModifiedString      () const;
+ uint64_t                     timeAccessed             () const;
+ std::string                  timeAccessedString       () const;
+ std::u32string               timeUAccessedString      () const;
+ const etk::FSNode &          operator =               (const etk::FSNode & _obj);
+ bool                         operator ==              (const etk::FSNode & _obj) const;
+ bool                         operator !=              (const etk::FSNode & _obj) const;
+ friendstd::ostream &         operator <<              (std::ostream & _os,
                                                         const etk::FSNode & _obj);
+ int64_t                      folderCount              ();
+ std::vector<etk::FSNode*>    folderGetSubList         (bool _showHidenFile,
                                                         bool _getFolderAndOther,
                                                         bool _getFile,
                                                         bool _temporaryFile);
+ etk::FSNode                  folderGetParent          ();
+ void                         folderGetRecursiveFiles  (std::vector<std::string> & _output,
                                                         bool _recursiveEnable);
+ void                         folderGetRecursiveFiles  (std::vector<std::u32string> & _output,
                                                         bool _recursiveEnable);
+ bool                         fileHasExtention         ();
+ std::string                  fileGetExtention         ();
+ std::u32string               fileUGetExtention        ();
+ uint64_t                     fileSize                 ();
+ bool                         fileOpenRead             ();
+ bool                         fileOpenWrite            ();
+ bool                         fileOpenAppend           ();
+ bool                         fileClose                ();
+ char*                        fileGets                 (char* _elementLine,
                                                         int64_t _maxData);
+ char                         fileGet                  ();
+ bool                         fileGets                 (std::string & _output);
+ bool                         filePut                  (char _input);
+ bool                         filePuts                 (const std::string & _input);
+ int64_t                      fileRead                 (void* _data,
                                                         int64_t _blockSize,
                                                         int64_t _nbBlock);
+ int64_t                      fileWrite                (const void* _data,
                                                         int64_t _blockSize,
                                                         int64_t _nbBlock);
+ int64_t                      fileTell                 ();
+ bool                         fileSeek                 (longint _offset,
                                                         enum etk::seekNode _origin);
+ void                         fileFlush                ();
+ std::vector<T>               fileReadAll              ();
+ std::string                  fileReadAllString        ();
+ std::u32string               fileReadAllU32String     ();
+ void                         fileWriteAll             (const std::vector<T> & _value);
+ void                         fileWriteAll             (const std::string & _value);
+ void                         fileWriteAll             (const std::u32string & _value);

Detail:

-

FSNode

+
FSNode
 +  FSNode (const std::string & _path);

 Constructor