XMLReader.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/robotinterface/XMLReader.h>
 
#include <yarp/robotinterface/Action.h>
#include <yarp/robotinterface/Device.h>
#include <yarp/robotinterface/Param.h>
#include <yarp/robotinterface/Robot.h>
#include <yarp/robotinterface/Types.h>
#include <yarp/robotinterface/XMLReader.h>
#include <yarp/robotinterface/impl/XMLReaderFileVx.h>
#include <yarp/robotinterface/impl/XMLReaderFileV1.h>
#include <yarp/robotinterface/impl/XMLReaderFileV3.h>
#include <yarp/robotinterface/impl/RobotInterfaceDTD.h>
 
#include <yarp/conf/filesystem.h>
 
#include <yarp/os/LogStream.h>
#include <yarp/os/Property.h>
 
#include <algorithm>
#include <iterator>
#include <memory>
#include <sstream>
#include <string>
#include <tinyxml.h>
#include <vector>
 
#define SYNTAX_ERROR(line) yError() << "Syntax error while loading" << curr_filename << "at line" << line << "."
#define SYNTAX_WARNING(line) yWarning() << "Invalid syntax while loading" << curr_filename << "at line" << line << "."
 
// BUG in TinyXML, see
// https://sourceforge.net/tracker/?func=detail&aid=3567726&group_id=13559&atid=113559
// When this bug is fixed upstream we can enable this
#define TINYXML_UNSIGNED_INT_BUG 0
 
class yarp::robotinterface::XMLReader::Private
{
public:
    ~Private()
    {
        delete mReader;
    }
 
    bool verbose{false};
    bool enable_deprecated{false};
    yarp::robotinterface::impl::XMLReaderFileVx* mReader{nullptr};
};
 
 
yarp::robotinterface::XMLReader::XMLReader() :
        mPriv(new Private)
{
}
 
yarp::robotinterface::XMLReader::~XMLReader()
{
    delete mPriv;
}
 
void yarp::robotinterface::XMLReader::setVerbose(bool verb)
{
    mPriv->verbose = verb;
}
 
void yarp::robotinterface::XMLReader::setEnableDeprecated(bool enab)
{
    mPriv->enable_deprecated = enab;
}
 
yarp::robotinterface::XMLReaderResult yarp::robotinterface::XMLReader::getRobotFromFile(const std::string& fileName,
                                                                                                                    const yarp::os::Searchable& config)
{
    std::string filename = fileName;
#if defined(_WIN32)
    std::replace(filename.begin(), filename.end(), '/', '\\');
#endif
    std::string curr_filename = fileName;
    std::string path = filename.substr(0, filename.rfind(yarp::conf::filesystem::preferred_separator));
 
    yDebug() << "Reading file" << filename.c_str();
    auto doc = std::make_unique< TiXmlDocument>(TiXmlDocument(filename.c_str()));
    if (!doc->LoadFile()) {
        SYNTAX_ERROR(doc->ErrorRow()) << doc->ErrorDesc();
        return yarp::robotinterface::XMLReaderResult::ParsingFailed();
    }
 
    if (!doc->RootElement()) {
        SYNTAX_ERROR(doc->Row()) << "No root element.";
        return yarp::robotinterface::XMLReaderResult::ParsingFailed();
    }
 
    RobotInterfaceDTD dtd;
 
    for (TiXmlNode* childNode = doc->FirstChild(); childNode != nullptr; childNode = childNode->NextSibling()) {
        if (childNode->Type() == TiXmlNode::TINYXML_UNKNOWN) {
            if (dtd.parse(childNode->ToUnknown(), curr_filename)) {
                break;
            }
        }
    }
 
    if (!dtd.valid()) {
        SYNTAX_WARNING(doc->Row()) << "No DTD found. Assuming version yarprobotinterfaceV3.0";
        dtd.setDefault();
        dtd.type = RobotInterfaceDTD::DocTypeRobot;
    }
 
    if (dtd.type != RobotInterfaceDTD::DocTypeRobot) {
        SYNTAX_WARNING(doc->Row()) << "Expected document of type" << DocTypeToString(RobotInterfaceDTD::DocTypeRobot)
                                   << ". Found" << DocTypeToString(dtd.type);
    }
 
    if (dtd.majorVersion == 1) {
        yError() << "DTD V1.x has been deprecated. Please update your configuration files to DTD v3.x";
        if (mPriv->enable_deprecated) {
            yWarning() << "yarprobotinterface: using DEPRECATED xml parser for DTD v1.x";
            mPriv->mReader = new yarp::robotinterface::impl::XMLReaderFileV1;
            return mPriv->mReader->getRobotFromFile(filename, config, mPriv->verbose);
        }
 
        yError("Invalid DTD version, execution stopped.");
        return yarp::robotinterface::XMLReaderResult::ParsingFailed();
 
    }
    if (dtd.majorVersion == 3) {
        yDebug() << "yarprobotinterface: using xml parser for DTD v3.x";
        mPriv->mReader = new yarp::robotinterface::impl::XMLReaderFileV3;
        return mPriv->mReader->getRobotFromFile(filename, config, mPriv->verbose);
    }
 
    //ERROR HERE
    yError("Invalid DTD version. Unable to choose parser for DTD.major: %d", dtd.majorVersion);
    return yarp::robotinterface::XMLReaderResult::ParsingFailed();
}
 
yarp::robotinterface::XMLReaderResult yarp::robotinterface::XMLReader::getRobotFromString(const std::string& xmlString,
                                                                                                                      const yarp::os::Searchable& config)
{
    std::string curr_filename = " XML runtime string ";
    std::unique_ptr<TiXmlDocument> doc = std::make_unique<TiXmlDocument>();
    if (!doc->Parse(xmlString.data())) {
        SYNTAX_ERROR(doc->ErrorRow()) << doc->ErrorDesc();
        return yarp::robotinterface::XMLReaderResult::ParsingFailed();
    }
    if (!doc->RootElement()) {
        SYNTAX_ERROR(doc->Row()) << "No root element.";
        return yarp::robotinterface::XMLReaderResult::ParsingFailed();
    }
 
    RobotInterfaceDTD dtd;
 
    for (TiXmlNode* childNode = doc->FirstChild(); childNode != nullptr; childNode = childNode->NextSibling()) {
        if (childNode->Type() == TiXmlNode::TINYXML_UNKNOWN) {
            std::string curr_filename = " XML runtime string ";
            if (dtd.parse(childNode->ToUnknown(), curr_filename)) {
                break;
            }
        }
    }
 
    if (!dtd.valid()) {
        SYNTAX_WARNING(doc->Row()) << "No DTD found. Assuming version yarprobotinterfaceV3.0";
        dtd.setDefault();
        dtd.type = RobotInterfaceDTD::DocTypeRobot;
    }
 
    if (dtd.type != RobotInterfaceDTD::DocTypeRobot) {
        SYNTAX_WARNING(doc->Row()) << "Expected document of type" << DocTypeToString(RobotInterfaceDTD::DocTypeRobot)
                                   << ". Found" << DocTypeToString(dtd.type);
    }
 
    if (dtd.majorVersion == 1) {
        yError() << "DTD V1.x has been deprecated. Please update your configuration files to DTD v3.x";
        if (mPriv->enable_deprecated) {
            yWarning() << "yarprobotinterface: using DEPRECATED xml parser for DTD v1.x";
            mPriv->mReader = new yarp::robotinterface::impl::XMLReaderFileV1;
            return mPriv->mReader->getRobotFromString(xmlString, config, mPriv->verbose);
        } else {
            yError("Invalid DTD version, execution stopped.");
            return yarp::robotinterface::XMLReaderResult::ParsingFailed();
        }
    } else if (dtd.majorVersion == 3) {
        yDebug() << "yarprobotinterface: using xml parser for DTD v3.x";
        mPriv->mReader = new yarp::robotinterface::impl::XMLReaderFileV3;
        return mPriv->mReader->getRobotFromString(xmlString, config, mPriv->verbose);
    }
 
    //ERROR HERE
    yError("Invalid DTD version. Unable to choose parser for DTD.major: %d", dtd.majorVersion);
    return yarp::robotinterface::XMLReaderResult::ParsingFailed();
}