xmlresloader.cpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#include <yarp/manager/xmlresloader.h>
#include <yarp/conf/filesystem.h>
#include <yarp/manager/utility.h>
#include <dirent.h>
#include <yarp/manager/physicresource.h>
#include <yarp/manager/logicresource.h>
 
#include <algorithm>
#include <cctype>
#include <string>
#include <fstream>
#include <yarp/manager/impl/textparser.h>
#include <tinyxml.h>
 
 
using namespace yarp::manager;
 
 
XmlResLoader::XmlResLoader(const char* szPath, const char* szName)
{
    parser = new(TextParser);
    if(strlen(szPath))
    {
        const std::string directorySeparator{yarp::conf::filesystem::preferred_separator};
        strPath = szPath;
        if ((strPath.rfind(directorySeparator) == std::string::npos) || (strPath.rfind(directorySeparator) != strPath.size() - 1)) {
            strPath = strPath + std::string(directorySeparator);
        }
    }
 
    if (szName) {
        strName = szName;
    }
}
 
XmlResLoader::XmlResLoader(const char* szFileName)
{
    parser = new(TextParser);
    if (szFileName) {
        strFileName = szFileName;
    }
}
 
 
 
XmlResLoader::~XmlResLoader()
{
    if(parser)
    {
        delete parser;
    }
}
 
 
bool XmlResLoader::init()
{
    fileNames.clear();
    ErrorLogger* logger  = ErrorLogger::Instance();
 
    if(!strFileName.empty())
    {
        fileNames.push_back(strFileName);
        return true;
    }
 
    if(strPath.empty())
    {
        logger->addError("No module path is introduced.");
        return false;
    }
 
    DIR *dir;
    struct dirent *entry;
    if ((dir = opendir(strPath.c_str())) == nullptr)
    {
        OSTRINGSTREAM err;
        err<<"Cannot access "<<strPath;
        logger->addError(err);
        return false;
    }
 
    /* we need to load all xml files */
    while((entry = readdir(dir)))
    {
        std::string name = entry->d_name;
        if(name.size() > 3)
        {
            std::string ext = name.substr(name.size()-3,3);
            if (compareString(ext.c_str(), "xml")) {
                fileNames.push_back(strPath + name);
            }
        }
    }
    closedir(dir);
 
    /*
    if(fileNames.empty())
    {
        OSTRINGSTREAM err;
        err<<"No xml resource file found in "<<strPath;
        logger->addWarning(err);
        //return true;
    }
    */
    return true;
}
 
 
void XmlResLoader::reset()
{
    fini();
    init();
}
 
 
void XmlResLoader::fini()
{
    fileNames.clear();
}
 
 
GenericResource* XmlResLoader::getNextResource()
{
    if(strName.empty())
    {
        if(computers.size())
        {
            dummyComputer = computers.back();
            computers.pop_back();
            return &dummyComputer;
        }
        else
        {
            bool ret = false;
            do
            {
                if (fileNames.empty()) {
                    return nullptr;
                }
 
                std::string fname = fileNames.back();
                fileNames.pop_back();
                ret = parsXml(fname.c_str());
            } while(!ret);
 
            dummyComputer = computers.back();
            computers.pop_back();
            return &dummyComputer;
        }
    }
    else
    {
         std::vector<std::string>::iterator itr;
         for(itr=fileNames.begin(); itr<fileNames.end(); itr++)
         {
             if(parsXml((*itr).c_str()))
             {
                 for (auto& computer : computers) {
                     if (std::string(computer.getName()) == strName) {
                         return &computer;
                     }
                 }
             }
         }
    }
    return nullptr;
}
 
 
 
bool XmlResLoader::parsXml(const char* szFile)
{
    computers.clear();
 
    ErrorLogger* logger  = ErrorLogger::Instance();
 
    TiXmlDocument doc(szFile);
    if(!doc.LoadFile())
    {
        OSTRINGSTREAM err;
        err<<"Syntax error while loading "<<szFile<<" at line "\
           <<doc.ErrorRow()<<": ";
        err<<doc.ErrorDesc();
        logger->addError(err);
        return false;
    }
    /* retrieving root module */
    TiXmlElement *root = doc.RootElement();
    if(!root)
    {
        OSTRINGSTREAM err;
        err<<"Syntax error while loading "<<szFile<<" . ";
        err<<"No root element.";
        logger->addError(err);
        return false;
    }
 
 
 
    if(!compareString(root->Value(), "resources"))
    {
        /*
        OSTRINGSTREAM msg;
        msg<<szFile<<" is not a resource descriptor file.";
        logger->addWarning(msg);
        */
        return false;
    }
 
    for(TiXmlElement* var = root->FirstChildElement("var"); var; var = var->NextSiblingElement())
    {
        if(var->Attribute("name") && var->GetText())
        {
            parser->addVariable(var->Attribute("name"), var->GetText());
        }
    }
 
    /* retrieving all computers descriptions */
    for(TiXmlElement* restag = root->FirstChildElement();
            restag; restag = restag->NextSiblingElement())
    {
        /* retrieving a computer resource */
        if(compareString(restag->Value(), "computer"))
        {
            Computer computer;
            computer.setXmlFile(szFile);
 
            for(TiXmlElement* comptag = restag->FirstChildElement();
                comptag; comptag = comptag->NextSiblingElement())
            {
                 /* retrieving name */
                 if (compareString(comptag->Value(), "name")) {
                     computer.setName(parser->parseText(comptag->GetText()).c_str());
                 }
 
                /* retrieving description */
                 if (compareString(comptag->Value(), "description")) {
                     computer.setDescription(parser->parseText(comptag->GetText()).c_str());
                 }
 
                /* retrieving disablility */
                if(compareString(comptag->Value(), "disable"))
                {
                    if (compareString(parser->parseText(comptag->GetText()).c_str(), "yes")) {
                        computer.setDisable(true);
                    }
                }
 
                // platform
                if(compareString(comptag->Value(), "platform"))
                {
                    Platform os;
                    TiXmlElement* element;
                    if ((element = (TiXmlElement*)comptag->FirstChild("name"))) {
                        os.setName(parser->parseText(element->GetText()).c_str());
                    } else {
                        OSTRINGSTREAM war;
                        war<<"Platform from "<<szFile<<" at line "\
                           <<comptag->Row()<<" has no name.";
                        logger->addWarning(war);
                    }
 
                    if ((element = (TiXmlElement*)comptag->FirstChild("distribution"))) {
                        os.setDistribution(parser->parseText(element->GetText()).c_str());
                    }
 
                    if ((element = (TiXmlElement*)comptag->FirstChild("release"))) {
                        os.setRelease(parser->parseText(element->GetText()).c_str());
                    }
 
                    computer.setPlatform(os);
                } // end of platform tag
 
                // memory
                if(compareString(comptag->Value(), "memory"))
                {
                    Memory mem;
                    TiXmlElement* element;
                    if ((element = (TiXmlElement*)comptag->FirstChild("total_space"))) {
                        mem.setTotalSpace((Capacity)atol(parser->parseText(element->GetText()).c_str()));
                    }
                   computer.setMemory(mem);
                } // end of memory tag
 
                // storage
                if(compareString(comptag->Value(), "storage"))
                {
                    Storage stg;
                    TiXmlElement* element;
                    if ((element = (TiXmlElement*)comptag->FirstChild("total_space"))) {
                        stg.setTotalSpace((Capacity)atol(parser->parseText(element->GetText()).c_str()));
                    }
                   computer.setStorage(stg);
                } // end of storage tag
 
                // processor
                if(compareString(comptag->Value(), "processor"))
                {
                    Processor proc;
                    TiXmlElement* element;
                    if ((element = (TiXmlElement*)comptag->FirstChild("architecture"))) {
                        proc.setArchitecture(parser->parseText(element->GetText()).c_str());
                    }
                    if ((element = (TiXmlElement*)comptag->FirstChild("model"))) {
                        proc.setModel(parser->parseText(element->GetText()).c_str());
                    }
                    if ((element = (TiXmlElement*)comptag->FirstChild("cores"))) {
                        proc.setCores((size_t)atoi(parser->parseText(element->GetText()).c_str()));
                    }
                    if ((element = (TiXmlElement*)comptag->FirstChild("frequency"))) {
                        proc.setFrequency(atof(parser->parseText(element->GetText()).c_str()));
                    }
                   computer.setProcessor(proc);
                } // end of processor tag
 
                // network
                if(compareString(comptag->Value(), "network"))
                {
                    Network net;
                    TiXmlElement* element;
                    if ((element = (TiXmlElement*)comptag->FirstChild("ip4"))) {
                        net.setIP4(parser->parseText(element->GetText()).c_str());
                    }
                    if ((element = (TiXmlElement*)comptag->FirstChild("ip6"))) {
                        net.setIP6(parser->parseText(element->GetText()).c_str());
                    }
                    if ((element = (TiXmlElement*)comptag->FirstChild("mac"))) {
                        net.setMAC(parser->parseText(element->GetText()).c_str());
                    }
                    computer.setNetwork(net);
                } // end of network tag
 
 
                // gpu
                if(compareString(comptag->Value(), "gpu"))
                {
                    GPU gpu;
                    TiXmlElement* element;
                    if ((element = (TiXmlElement*)comptag->FirstChild("name"))) {
                        gpu.setName(parser->parseText(element->GetText()).c_str());
                    }
                    if ((element = (TiXmlElement*)comptag->FirstChild("capability"))) {
                        gpu.setCompCompatibility(parser->parseText(element->GetText()).c_str());
                    }
                    if ((element = (TiXmlElement*)comptag->FirstChild("cores"))) {
                        gpu.setCores((size_t)atoi(parser->parseText(element->GetText()).c_str()));
                    }
                    if ((element = (TiXmlElement*)comptag->FirstChild("frequency"))) {
                        gpu.setFrequency(atof(parser->parseText(element->GetText()).c_str()));
                    }
                    if ((element = (TiXmlElement*)comptag->FirstChild("register_block"))) {
                        gpu.setResgisterPerBlock((size_t)atoi(parser->parseText(element->GetText()).c_str()));
                    }
                    if ((element = (TiXmlElement*)comptag->FirstChild("thread_block"))) {
                        gpu.setThreadPerBlock((size_t)atoi(parser->parseText(element->GetText()).c_str()));
                    }
                    if((element = (TiXmlElement*) comptag->FirstChild("overlap")))
                    {
                        if (compareString(parser->parseText(element->GetText()).c_str(), "yes")) {
                            gpu.setOverlap(true);
                        } else {
                            gpu.setOverlap(false);
                        }
                    }
 
                    // global memory
                    if(comptag->FirstChild("global_memory"))
                    {
                        TiXmlElement* element;
                        element = (TiXmlElement*) comptag->FirstChild("global_memory");
                        if ((element = (TiXmlElement*)element->FirstChild("total_space"))) {
                            gpu.setGlobalMemory((Capacity)atol(parser->parseText(element->GetText()).c_str()));
                        }
                    } // end of global memory tag
 
                    // shared memory
                    if(comptag->FirstChild("shared_memory"))
                    {
                        TiXmlElement* element;
                        element = (TiXmlElement*) comptag->FirstChild("shared_memory");
                        if ((element = (TiXmlElement*)element->FirstChild("total_space"))) {
                            gpu.setSharedMemory((Capacity)atol(parser->parseText(element->GetText()).c_str()));
                        }
                    } // end of shared memory tag
 
                    // constant memory
                    if(comptag->FirstChild("constant_memory"))
                    {
                        TiXmlElement* element;
                        element = (TiXmlElement*) comptag->FirstChild("constant_memory");
                        if ((element = (TiXmlElement*)element->FirstChild("total_space"))) {
                            gpu.setConstantMemory((Capacity)atol(parser->parseText(element->GetText()).c_str()));
                        }
                    } // end of shared memory tag
 
                   computer.addPeripheral(gpu);
                } // end of gpu tag
            } // end of computer loop
 
            computers.push_back(computer);
        } // end of if computer
    } // end of resources
    return true;
}