Fixed #1 read from binary file also added unit-test

Author: sea5kg

src/wsjcpp_obj_tree.cpp

@@ -11,7 +11,6 @@ WsjcppObjTreeNode::WsjcppObjTreeNode(WsjcppObjTree *pTree, uint16_t nType) {
     m_pTree = pTree;
     m_pParent = nullptr;
     m_nType = nType;
-    // TODO regestry in global factory
 }
 
 // ---------------------------------------------------------------------
@@ -92,8 +91,71 @@ WsjcppObjTree::~WsjcppObjTree() {
 
 bool WsjcppObjTree::readTreeFromFile(const std::string &sFilename, std::string &sError) {
     if (!WsjcppCore::fileExists(sFilename)) {
+        sError = "File not exists";
         return false;
     }
+
+    clearNodes();
+    std::ifstream f;
+    f.open(sFilename.c_str(), std::ios::in | std::ios::binary);
+
+    uint32_t nTreeSize = 0;
+    if (!this->readUInt32(f, nTreeSize, sError)) {
+        return false;
+    }
+
+    if (!this->readUInt32(f, m_nLastId, sError)) {
+        return false;
+    }
+
+    std::map<uint32_t, WsjcppObjTreeNode *> mapTempIdToNode;
+    for (int i = 0; i < nTreeSize; i++) {
+        uint16_t nNodeType = 0;
+        if (!this->readUInt16(f, nNodeType, sError)) {
+            return false;
+        }
+
+        if (m_mapFabricTreeNode.find(nNodeType) == m_mapFabricTreeNode.end()) {
+            sError = "On read file could not found node type: " + std::to_string(nNodeType);
+            return false;
+        }
+
+        // read parent id
+        uint32_t nParentId = 0;
+        if (!this->readUInt32(f, nParentId, sError)) {
+            return false;
+        }
+        WsjcppObjTreeNode *pParentNode = nullptr; // TODO find by Id
+
+        if (mapTempIdToNode.find(nParentId) != mapTempIdToNode.end()) {
+            pParentNode = mapTempIdToNode[nParentId];
+        }
+
+        // read node id
+        uint32_t nNodeId = 0;
+        if (!this->readUInt32(f, nNodeId, sError)) {
+            return false;
+        }
+        
+
+        if (nNodeId > m_nLastId) {
+            sError = "Node id '" + std::to_string(nNodeId) + "' could not more then last id " + std::to_string(m_nLastId);
+            return false;
+        }
+
+        WsjcppObjTreeNode *pNode = m_mapFabricTreeNode[nNodeType]->create();
+        pNode->setId(nNodeId);
+        pNode->setParent(pParentNode);
+        if (pParentNode != nullptr) {
+            pParentNode->addChild(pNode);
+        }
+        if (!pNode->readDataPartFromFile(f, sError)) {
+            return false;
+        }
+        mapTempIdToNode[nNodeId] = pNode;
+        m_vNodes.push_back(pNode);
+    }
+    f.close();
     return true;
 }
 
@@ -222,24 +284,43 @@ std::string WsjcppObjTree::toString() { // for printing
 // ---------------------------------------------------------------------
 
 void WsjcppObjTree::writeUInt32(std::ofstream &f, uint32_t nVal) {
+    const char *pBuffer = reinterpret_cast<const char *>(&nVal);
+    f.write(pBuffer, 4);
+}
+
+// ---------------------------------------------------------------------
+
+bool WsjcppObjTree::readUInt32(std::ifstream &f, uint32_t &nVal, std::string &sError) {
     // not for multithreading
-    // TODO redesign to reinterpret_cast<const char *>(&m_nValue);
-    static unsigned char arrInteger[4];
-    arrInteger[0] = (nVal >> 24) & 0xFF;
-    arrInteger[1] = (nVal >> 16) & 0xFF;
-    arrInteger[2] = (nVal >> 8) & 0xFF;
-    arrInteger[3] = nVal & 0xFF;
-    f.write((const char *)arrInteger, 4);
+    static char arrInteger[4];
+    f.read(arrInteger, 4);
+    if (!f) {
+        sError = "Could not read. File broken. Can read " + std::to_string(f.gcount());
+        return false;
+    }
+    nVal = *reinterpret_cast<uint32_t*>(arrInteger);
+    return true;
 }
 
 // ---------------------------------------------------------------------
 
 void WsjcppObjTree::writeUInt16(std::ofstream &f, uint16_t nVal) {
+    const char *pBuffer = reinterpret_cast<const char *>(&nVal);
+    f.write(pBuffer, 2);
+}
+
+// ---------------------------------------------------------------------
+
+bool WsjcppObjTree::readUInt16(std::ifstream &f, uint16_t &nVal, std::string &sError) {
     // not for multithreading
-    static unsigned char arrShort[2];
-    arrShort[0] = (nVal >> 8) & 0xFF;
-    arrShort[1] = nVal & 0xFF;
-    f.write((const char *)arrShort, 2);
+    static char arrShort[2];
+    f.read(arrShort, 2);
+    if (!f) {
+        sError = "Could not read. File broken. Can read " + std::to_string(f.gcount());
+        return false;
+    }
+    nVal = *reinterpret_cast<uint16_t*>(arrShort);
+    return true;
 }
 
 // ---------------------------------------------------------------------
@@ -337,6 +418,28 @@ const char *WsjcppObjTreeNodeString::getData() {
 
 // ---------------------------------------------------------------------
 
+bool WsjcppObjTreeNodeString::readDataPartFromFile(std::ifstream &f, std::string &sError) {
+    uint32_t nStringLen = 0;
+    char arrInteger[4];
+    f.read(arrInteger, 4);
+    if (!f) {
+        sError = "WsjcppObjTreeNodeString. Could not read string len. File broken. Can read " + std::to_string(f.gcount());
+        return false;
+    }
+    nStringLen = *reinterpret_cast<uint32_t*>(arrInteger);
+    char *pStr = new char[nStringLen];
+    f.read(pStr, nStringLen);
+    if (!f) {
+        delete pStr;
+        sError = "WsjcppObjTreeNodeString. Could not read string data. File broken. Can read " + std::to_string(f.gcount());
+        return false;
+    }
+    m_sValue = std::string(pStr, nStringLen);
+    return true;
+}
+
+// ---------------------------------------------------------------------
+
 std::string WsjcppObjTreeNodeString::toString(const std::string &sIntent) {
     return "string: " + m_sValue;
 }
@@ -376,6 +479,28 @@ const char *WsjcppObjTreeNodeInteger::getData() {
 
 // ---------------------------------------------------------------------
 
+bool WsjcppObjTreeNodeInteger::readDataPartFromFile(std::ifstream &f, std::string &sError) {
+    // size
+    // TODO remove - because  this not need
+    char arrBytes[4];
+    f.read(arrBytes, 4);
+    if (!f) {
+        sError = "WsjcppObjTreeNodeInteger. Could not read string len. File broken. Can read " + std::to_string(f.gcount());
+        return false;
+    }
+    // value 
+    f.read(arrBytes, 4);
+    if (!f) {
+        sError = "WsjcppObjTreeNodeInteger. Could not read string len. File broken. Can read " + std::to_string(f.gcount());
+        return false;
+    }
+    static_assert(sizeof(uint32_t) == 4, "Expected sizeof(uint32_t) == 4");
+    m_nValue = *reinterpret_cast<uint32_t*>(arrBytes);
+    return true;
+}
+
+// ---------------------------------------------------------------------
+
 std::string WsjcppObjTreeNodeInteger::toString(const std::string &sIntent) {
     return "int: " + std::to_string(m_nValue);
 }
@@ -415,6 +540,28 @@ const char *WsjcppObjTreeNodeFloat::getData() {
 
 // ---------------------------------------------------------------------
 
+bool WsjcppObjTreeNodeFloat::readDataPartFromFile(std::ifstream &f, std::string &sError) {
+    static_assert(sizeof(float) == 4, "Expected sizeof(float) == 4");
+    // size
+    // TODO remove - because  this not need
+    char arrBytes[4];
+    f.read(arrBytes, 4);
+    if (!f) {
+        sError = "WsjcppObjTreeNodeInteger. Could not read string len. File broken. Can read " + std::to_string(f.gcount());
+        return false;
+    }
+    // value 
+    f.read(arrBytes, 4);
+    if (!f) {
+        sError = "WsjcppObjTreeNodeFloat. Could not read string len. File broken. Can read " + std::to_string(f.gcount());
+        return false;
+    }
+    m_nValue = *reinterpret_cast<float*>(arrBytes);
+    return true;
+}
+
+// ---------------------------------------------------------------------
+
 std::string WsjcppObjTreeNodeFloat::toString(const std::string &sIntent) {
     return "float: " + std::to_string(m_nValue);
 }
@@ -454,6 +601,29 @@ const char *WsjcppObjTreeNodeDouble::getData() {
 
 // ---------------------------------------------------------------------
 
+bool WsjcppObjTreeNodeDouble::readDataPartFromFile(std::ifstream &f, std::string &sError) {
+    static_assert(sizeof(double) == 8, "Expected sizeof(double) == 8");
+    // size
+    // TODO remove - because  this not need
+    char arrBytes4[4];
+    f.read(arrBytes4, 4);
+    if (!f) {
+        sError = "WsjcppObjTreeNodeInteger. Could not read string len. File broken. Can read " + std::to_string(f.gcount());
+        return false;
+    }
+    // value
+    char arrBytes[8];
+    f.read(arrBytes, 8);
+    if (!f) {
+        sError = "WsjcppObjTreeNodeDouble. Could not read string len. File broken. Can read " + std::to_string(f.gcount());
+        return false;
+    }
+    m_nValue = *reinterpret_cast<double*>(arrBytes);
+    return true;
+}
+
+// ---------------------------------------------------------------------
+
 std::string WsjcppObjTreeNodeDouble::toString(const std::string &sIntent) {
     return "double: " + std::to_string(m_nValue);
 }

src/wsjcpp_obj_tree.h

@@ -26,6 +26,8 @@ class WsjcppObjTreeNode {
         // virtual zero methods will be deny create basic class
         virtual int getDataSize() = 0;
         virtual const char *getData() = 0;
+        virtual bool readDataPartFromFile(std::ifstream &f, std::string &sError) = 0;
+
         virtual std::string toString(const std::string &sIntent = "") = 0;
 
         WsjcppObjTreeNode *getParent();
@@ -41,9 +43,9 @@ class WsjcppObjTreeNode {
     private:
         WsjcppObjTree *m_pTree;
         WsjcppObjTreeNode *m_pParent;
-        uint32_t m_nId;
+        uint32_t m_nId; // it uniq identified node in a list
         std::vector<WsjcppObjTreeNode *> m_vChilds;
-        uint16_t m_nType;  
+        uint16_t m_nType;
 };
 
 class IFabricWsjcppObjTreeNode {
@@ -116,11 +118,14 @@ class WsjcppObjTree {
     private:
         std::string TAG;
         std::vector<WsjcppObjTreeNode *> m_vNodes;
-        int m_nLastId;
+        uint32_t m_nLastId; // Need for future if will be implemented function of remove nodes
         std::map<uint16_t, IFabricWsjcppObjTreeNode*> m_mapFabricTreeNode;
 
         void writeUInt32(std::ofstream &f, uint32_t nVal);
+        bool readUInt32(std::ifstream &f, uint32_t &nVal, std::string &sError);
+
         void writeUInt16(std::ofstream &f, uint16_t nVal);
+        bool readUInt16(std::ifstream &f, uint16_t &nVal, std::string &sError);
 
         std::string toStringRecoursiveChilds(WsjcppObjTreeNode *pNode, const std::string &sIntent);
 };
@@ -171,6 +176,7 @@ class WsjcppObjTreeNodeString : public WsjcppObjTreeNode {
         // WsjcppObjTreeNode
         virtual int getDataSize() override;
         virtual const char *getData() override;
+        virtual bool readDataPartFromFile(std::ifstream &f, std::string &sError) override;
         virtual std::string toString(const std::string &sIntent = "") override;
 
     private:
@@ -191,6 +197,7 @@ class WsjcppObjTreeNodeInteger : public WsjcppObjTreeNode {
         // WsjcppObjTreeNode
         virtual int getDataSize() override;
         virtual const char *getData() override;
+        virtual bool readDataPartFromFile(std::ifstream &f, std::string &sError) override;
         virtual std::string toString(const std::string &sIntent = "") override;
 
     private:
@@ -210,6 +217,7 @@ class WsjcppObjTreeNodeFloat : public WsjcppObjTreeNode {
         // WsjcppObjTreeNode
         virtual int getDataSize() override;
         virtual const char *getData() override;
+        virtual bool readDataPartFromFile(std::ifstream &f, std::string &sError) override;
         virtual std::string toString(const std::string &sIntent = "") override;
 
     private:
@@ -230,6 +238,7 @@ class WsjcppObjTreeNodeDouble : public WsjcppObjTreeNode {
         // WsjcppObjTreeNode
         virtual int getDataSize() override;
         virtual const char *getData() override;
+        virtual bool readDataPartFromFile(std::ifstream &f, std::string &sError) override;
         virtual std::string toString(const std::string &sIntent = "") override;
 
     private:

unit-tests.wsjcpp/CMakeLists.txt

@@ -42,6 +42,8 @@ list (APPEND WSJCPP_SOURCES "../unit-tests.wsjcpp/src/unit_test_write_tree.h")
 list (APPEND WSJCPP_SOURCES "../unit-tests.wsjcpp/src/unit_test_write_tree.cpp")
 list (APPEND WSJCPP_SOURCES "../unit-tests.wsjcpp/src/unit_test_find_nodes.h")
 list (APPEND WSJCPP_SOURCES "../unit-tests.wsjcpp/src/unit_test_find_nodes.cpp")
+list (APPEND WSJCPP_SOURCES "../unit-tests.wsjcpp/src/unit_test_read_tree.h")
+list (APPEND WSJCPP_SOURCES "../unit-tests.wsjcpp/src/unit_test_read_tree.cpp")
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/CMakeLists.user-custom.txt)
 

unit-tests.wsjcpp/data/readtreetest/example1.obj-tree

@@ -0,0 +1,51 @@
+#include "unit_test_read_tree.h"
+#include <vector>
+#include <wsjcpp_core.h>
+#include <wsjcpp_obj_tree.h>
+
+REGISTRY_WSJCPP_UNIT_TEST(UnitTestReadTree)
+
+UnitTestReadTree::UnitTestReadTree()
+    : WsjcppUnitTestBase("UnitTestReadTree") {
+}
+
+// ---------------------------------------------------------------------
+
+void UnitTestReadTree::init() {
+    // nothing
+}
+
+// ---------------------------------------------------------------------
+
+class CompStruct : public WsjcppObjTree {
+    public:
+        CompStruct() {
+            addSupportType<WsjcppObjTreeNodeString>();
+            addSupportType<WsjcppObjTreeNodeInteger>();
+            addSupportType<WsjcppObjTreeNodeFloat>();
+            addSupportType<WsjcppObjTreeNodeDouble>();
+        }
+};
+
+bool UnitTestReadTree::run() {
+    bool bTestSuccess = true;
+
+    // TODO will be chnaged this to keeped files on the disk
+    CompStruct comp;
+
+    std::string sFilename = "./data/readtreetest/example1.obj-tree";
+    std::string sError;
+    bool bWrote = comp.readTreeFromFile(sFilename, sError);
+    compareB(bTestSuccess, "read from file", bWrote, true);
+
+    WsjcppLog::info(TAG, "\n" + comp.toString());
+        
+    // char *pBuffer = nullptr;
+    // int nBufferSize = 0;
+    // WsjcppCore::readFileToBuffer(sFilename, &pBuffer, nBufferSize);
+
+    // compareN(bTestSuccess, "read to file", nBufferSize, 296);
+    
+    return bTestSuccess;
+}
+

unit-tests.wsjcpp/data/tmp/example.obj-tree

@@ -0,0 +1,15 @@
+#ifndef UNIT_TEST_READ_TREE_H
+#define UNIT_TEST_READ_TREE_H
+
+#include <wsjcpp_unit_tests.h>
+
+// Description: TODO
+class UnitTestReadTree : public WsjcppUnitTestBase {
+    public:
+        UnitTestReadTree();
+        virtual void init();
+        virtual bool run();
+};
+
+#endif // UNIT_TEST_READ_TREE_H
+