StepDirectory.cpp

#include "StepDirectory.h"
#include <filesystem>
#include "LayerDirectory.h"
#include <fstream>
#include <sstream>
#include "Logger.h"
#include <memory>
#include "../../Text/Utf8Sanitizer.h"
 
 
namespace Odb::Lib::FileModel::Design
{
    StepDirectory::StepDirectory(std::filesystem::path path)
        : m_path(path)
    {
    }
 
    StepDirectory::~StepDirectory()
    {
        m_layersByName.clear();
        m_netlistsByName.clear();
    }
 
    std::string StepDirectory::GetName()
    {
        return m_name;
    }
 
    std::filesystem::path StepDirectory::GetPath()
    {
        return m_path;
    }
 
    const EdaDataFile& StepDirectory::GetEdaDataFile() const { return m_edaData; }
    const LayerDirectory::StringMap& StepDirectory::GetLayersByName() const { return m_layersByName; }
    const NetlistFile::StringMap& StepDirectory::GetNetlistsByName() const { return m_netlistsByName; }
 
    const AttrListFile& StepDirectory::GetAttrListFile() const
    {
        return m_attrListFile;
    }
 
    const FeaturesFile& StepDirectory::GetProfileFile() const
    {
        return m_profileFile;
    }
 
    const StepHdrFile& StepDirectory::GetStepHdrFile() const
    {
        return m_stepHdrFile;
    }
 
    bool StepDirectory::Parse()
    {
        if (!std::filesystem::exists(m_path)) return false;
        else if (!std::filesystem::is_directory(m_path)) return false;
 
        m_name = std::filesystem::path(m_path).filename().string();
 
        loginfo("Parsing step directory: " + m_name + "...");
 
        auto layersPath = m_path / "layers";
        if (!ParseLayerFiles(layersPath)) return false;
 
        auto netlistsPath = m_path / "netlists";
        if (!ParseNetlistFiles(netlistsPath)) return false;
 
        auto edaPath = m_path / "eda";
        if (!ParseEdaDataFiles(edaPath)) return false;
 
        auto attrListPath = m_path;
        if (!ParseAttrListFile(attrListPath)) return false;
 
        auto profilePath = m_path;
        if (!ParseProfileFile(profilePath)) return false;
 
        auto stepHdrPath = m_path;
        if (!ParseStepHdrFile(stepHdrPath)) return false;
 
        loginfo("Parsing step directory: " + m_name + " complete");
 
        return true;
    }
 
    bool StepDirectory::ParseLayerFiles(std::filesystem::path layersPath)
    {
        loginfo("Parsing layer directories...");
 
        if (!std::filesystem::exists(layersPath)) return false;
        else if (!std::filesystem::is_directory(layersPath)) return false;
 
        for (auto& d : std::filesystem::directory_iterator(layersPath))
        {
            if (std::filesystem::is_directory(d))
            {
                auto pLayer = std::make_shared<LayerDirectory>(d.path());               
                if (pLayer->Parse())
                {
                    loginfo("Parsing layer: " + pLayer->GetName() + " complete");
 
                    m_layersByName[pLayer->GetName()] = pLayer;
                }
                else
                {
                    return false;
                }
            }
        }
 
        loginfo("Parsing layer directories complete");
 
        return true;
    }
 
    bool StepDirectory::ParseEdaDataFiles(std::filesystem::path edaPath)
    {
        loginfo("Parsing eda/data file...");
 
        if (!std::filesystem::exists(edaPath)) return false;
        else if (!std::filesystem::is_directory(edaPath)) return false;
 
        // parse nets and packages definitions      
        auto success =  m_edaData.Parse(edaPath);
 
        loginfo("Parsing eda/data file complete");
 
        return success;
    }
 
    bool StepDirectory::ParseAttrListFile(std::filesystem::path attrListFileDirectory)
    {
        loginfo("Parsing attrlist file...");
 
        if (!std::filesystem::exists(attrListFileDirectory)) return false;
        if (!std::filesystem::is_directory(attrListFileDirectory)) return false;
 
        // parse nets and packages definitions      
        auto success = m_attrListFile.Parse(attrListFileDirectory);
 
        loginfo("Parsing attrlist file complete");
 
        return success;        
    }
 
    bool StepDirectory::ParseProfileFile(std::filesystem::path profileFileDirectory)
    {
        loginfo("Parsing profile file...");
 
        if (!std::filesystem::exists(profileFileDirectory)) return false;
        if (!std::filesystem::is_directory(profileFileDirectory)) return false;
 
        // parse nets and packages definitions      
        auto success = m_profileFile.Parse(profileFileDirectory, PROFILE_FILENAME);
 
        loginfo("Parsing profile file complete");
 
        return success;
    }
 
    bool StepDirectory::ParseStepHdrFile(std::filesystem::path stepHdrFileDirectory)
    {
        loginfo("Parsing stephdr file...");
 
        if (!std::filesystem::exists(stepHdrFileDirectory)) return false;
        if (!std::filesystem::is_directory(stepHdrFileDirectory)) return false;
 
        // parse nets and packages definitions      
        auto success = m_stepHdrFile.Parse(stepHdrFileDirectory);
 
        loginfo("Parsing stephdr file complete");
 
        return success;
    }
 
    bool StepDirectory::Save(const std::filesystem::path& directory)
    {
        auto stepDir = directory / m_name;
        if (!create_directory(stepDir)) return false;
 
        // eda/data
        auto edaPath = stepDir / "eda";
        if (!create_directory(edaPath)) return false;
        std::ofstream edaDataFile(edaPath / "data");
        if (!m_edaData.Save(edaDataFile)) return false;
        edaDataFile.close();
 
        // attrlist
        std::ofstream attrlistFile(stepDir / "attrlist");
        if (!m_attrListFile.Save(attrlistFile)) return false;
        attrlistFile.close();
 
        // profile
        std::ofstream profileFile(stepDir / "profile");
        if (!m_profileFile.Save(profileFile)) return false;
        profileFile.close();
 
        // StepHdrFile
        std::ofstream stephdrFile(stepDir / "stephdr");
        if (!m_stepHdrFile.Save(stephdrFile)) return false;
        stephdrFile.close();
 
        // layers
        auto layersPath = stepDir / "layers";
        if (!create_directory(layersPath)) return false;
        for (auto& kvLayer : m_layersByName)
        {
            if (!kvLayer.second->Save(layersPath)) return false;
        }
        
        // m_netlistsByName;
        auto netlistsPath = stepDir / "netlists";
        if (!create_directory(netlistsPath)) return false;
        for (auto& kvNetlist : m_netlistsByName)
        {
            if (!kvNetlist.second->Save(netlistsPath)) return false;
        }
 
        return true;
    }
 
    std::unique_ptr<Odb::Lib::Protobuf::StepDirectory> StepDirectory::to_protobuf() const
    {
        std::unique_ptr<Odb::Lib::Protobuf::StepDirectory> pStepDirectoryMessage(new Odb::Lib::Protobuf::StepDirectory);
        pStepDirectoryMessage->set_name(Odb::Lib::Text::ToUtf8(m_name));
        pStepDirectoryMessage->set_path(Odb::Lib::Text::ToUtf8(m_path.string()));
        pStepDirectoryMessage->mutable_edadatafile()->CopyFrom(*m_edaData.to_protobuf());
        pStepDirectoryMessage->mutable_attrlistfile()->CopyFrom(*m_attrListFile.to_protobuf());
        pStepDirectoryMessage->mutable_profilefile()->CopyFrom(*m_profileFile.to_protobuf());
        pStepDirectoryMessage->mutable_stephdrfile()->CopyFrom(*m_stepHdrFile.to_protobuf());
 
        for (const auto& kvNetlistFile : m_netlistsByName)
        {
            (*pStepDirectoryMessage->mutable_netlistsbyname())[Odb::Lib::Text::ToUtf8(kvNetlistFile.first)] = *kvNetlistFile.second->to_protobuf();
        }
 
        for (const auto& kvLayerDirectoryRecord : m_layersByName)
        {
            (*pStepDirectoryMessage->mutable_layersbyname())[Odb::Lib::Text::ToUtf8(kvLayerDirectoryRecord.first)] = *kvLayerDirectoryRecord.second->to_protobuf();
        }
 
        return pStepDirectoryMessage;
    }
 
    void StepDirectory::from_protobuf(const Odb::Lib::Protobuf::StepDirectory& message)
    {
        m_name = message.name();
        m_path = message.path();
        m_edaData.from_protobuf(message.edadatafile());
        m_attrListFile.from_protobuf(message.attrlistfile());
        m_profileFile.from_protobuf(message.profilefile());
        m_stepHdrFile.from_protobuf(message.stephdrfile());
 
        for (const auto& kvNetlistFile : message.netlistsbyname())
        {
            auto pNetlistFile = std::make_shared<NetlistFile>(std::filesystem::path(kvNetlistFile.second.path()));
            pNetlistFile->from_protobuf(kvNetlistFile.second);
            m_netlistsByName[kvNetlistFile.first] = pNetlistFile;
        }
 
        for (const auto& kvLayerDirectoryRecord : message.layersbyname())
        {
            auto pLayerDirectory = std::make_shared<LayerDirectory>(std::filesystem::path(kvLayerDirectoryRecord.second.path()));
            pLayerDirectory->from_protobuf(kvLayerDirectoryRecord.second);
            m_layersByName[kvLayerDirectoryRecord.first] = pLayerDirectory;
        }
    }
 
    bool StepDirectory::ParseNetlistFiles(std::filesystem::path netlistsPath)
    {
        loginfo("Parsing netlist files...");
 
        std::size_t netListDirectoriesFound = 0;
 
        if (std::filesystem::exists(netlistsPath))
        {
            if (std::filesystem::is_directory(netlistsPath))
            {                
                // parse net name records
                for (auto& d : std::filesystem::directory_iterator(netlistsPath))
                {
                    if (std::filesystem::is_directory(d))
                    {
                        netListDirectoriesFound++;
 
                        auto pNetlist = std::make_shared<NetlistFile>(d.path());
                        if (pNetlist->Parse())
                        {
                            m_netlistsByName[pNetlist->GetName()] = pNetlist;
                        }
                        else
                        {
                            // pNetList will be freed when exiting the above scope
                            logerror("Failed to parse netlist directory: " + pNetlist->GetName());
                        }
                    }
                }
            }
        }
       
        if (netListDirectoriesFound == 0)   // netlist dirs found, but none parsed successfully
        {      
            logwarn("No netlist directories found");
        }
        else if (netListDirectoriesFound == m_netlistsByName.size())
        {
            loginfo("netlist directories parsed successfully");
        }
 
        return true;
    }
 
    const ComponentsFile* StepDirectory::GetTopComponentsFile() const
    {
        auto findIt = m_layersByName.find(ComponentsFile::TOP_COMPONENTS_LAYER_NAME);
        if (findIt != m_layersByName.end())
        {
            return &(findIt->second->GetComponentsFile());
        }
        else
        {
            return nullptr;
        }
    }
 
    const ComponentsFile* StepDirectory::GetBottomComponentsFile() const
    {
        auto findIt = m_layersByName.find(ComponentsFile::BOTTOM_COMPONENTS_LAYER_NAME);
        if (findIt != m_layersByName.end())
        {
            return &(findIt->second->GetComponentsFile());
        }
        else
        {
            return nullptr;
        }
    }
}