XmlHelpers.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2021, The DART development contributors
 * All rights reserved.
 *
 * The list of contributors can be found at:
 *   https://github.com/dartsim/dart/blob/master/LICENSE
 *
 * This file is provided under the following "BSD-style" License:
 *   Redistribution and use in source and binary forms, with or
 *   without modification, are permitted provided that the following
 *   conditions are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 *   CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 *   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 *   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 *   AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *   POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef DART_UTILS_XMLHELPERS_HPP_
#define DART_UTILS_XMLHELPERS_HPP_
 
#include <string>
 
#include <Eigen/Dense>
#include <boost/algorithm/string.hpp>
#include <boost/lexical_cast.hpp>
#include <tinyxml2.h>
 
#include "dart/common/Console.hpp"
#include "dart/common/Deprecated.hpp"
#include "dart/common/ResourceRetriever.hpp"
#include "dart/math/MathTypes.hpp"
 
namespace dart {
namespace utils {
 
std::string toString(bool v);
std::string toString(int v);
std::string toString(unsigned int v);
std::string toString(float v);
std::string toString(double v);
std::string toString(char v);
std::string toString(const Eigen::Vector2d& v);
std::string toString(const Eigen::Vector3d& v);
std::string toString(const Eigen::Vector3i& v);
std::string toString(const Eigen::Vector6d& v);
std::string toString(const Eigen::VectorXd& v);
std::string toString(const Eigen::Isometry3d& v);
 
bool toBool(const std::string& str);
int toInt(const std::string& str);
unsigned int toUInt(const std::string& str);
float toFloat(const std::string& str);
double toDouble(const std::string& str);
char toChar(const std::string& str);
Eigen::Vector2d toVector2d(const std::string& str);
Eigen::Vector2i toVector2i(const std::string& str);
Eigen::Vector3d toVector3d(const std::string& str);
Eigen::Vector3i toVector3i(const std::string& str);
Eigen::Vector4d toVector4d(const std::string& str);
Eigen::Vector6d toVector6d(const std::string& str);
Eigen::VectorXd toVectorXd(const std::string& str);
template <std::size_t N>
Eigen::Matrix<double, N, 1> toVectorNd(const std::string& str)
{
  Eigen::Matrix<double, N, 1> ret = Eigen::Matrix<double, N, 1>::Zero();
 
  std::vector<std::string> pieces;
  std::string trimedStr = boost::trim_copy(str);
  boost::split(
      pieces, trimedStr, boost::is_any_of(" "), boost::token_compress_on);
  std::size_t sizeToRead = std::min(N, pieces.size());
  if (pieces.size() < N)
  {
    dterr << "Failed to read a vector because the dimension '" << pieces.size()
          << "' is less than the expectation '" << N << "'.\n";
  }
  else if (pieces.size() > N)
  {
    dterr << "Failed to read a vector because the dimension '" << pieces.size()
          << "' is greater than the expectation '" << N << "'.\n";
  }
 
  for (std::size_t i = 0; i < sizeToRead; ++i)
  {
    if (pieces[i] != "")
    {
      try
      {
        ret(i) = boost::lexical_cast<double>(pieces[i].c_str());
      }
      catch (boost::bad_lexical_cast& e)
      {
        dterr << "value [" << pieces[i]
              << "] is not a valid double for Eigen::Vector" << N << "d[" << i
              << "]: " << e.what() << "\n";
      }
    }
  }
 
  return ret;
}
// TODO: The definition of _str is not clear for transform (see: #250)
Eigen::Isometry3d toIsometry3d(const std::string& str);
Eigen::Isometry3d toIsometry3dWithExtrinsicRotation(const std::string& str);
 
std::string getValueString(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
bool getValueBool(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
int getValueInt(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
unsigned int getValueUInt(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
float getValueFloat(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
double getValueDouble(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
char getValueChar(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
Eigen::Vector2d getValueVector2d(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
Eigen::Vector3d getValueVector3d(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
Eigen::Vector3i getValueVector3i(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
Eigen::Vector6d getValueVector6d(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
Eigen::VectorXd getValueVectorXd(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
Eigen::Isometry3d getValueIsometry3d(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
Eigen::Isometry3d getValueIsometry3dWithExtrinsicRotation(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
 
// TODO(JS): Deprecate
void openXMLFile(
    tinyxml2::XMLDocument& doc,
    const common::Uri& uri,
    const common::ResourceRetrieverPtr& retriever = nullptr);
 
bool readXmlFile(
    tinyxml2::XMLDocument& doc,
    const common::Uri& uri,
    const common::ResourceRetrieverPtr& retrieverOrNullPtr = nullptr);
 
bool hasElement(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
 
const tinyxml2::XMLElement* getElement(
    const tinyxml2::XMLElement* parentElement, const std::string& name);
 
tinyxml2::XMLElement* getElement(
    tinyxml2::XMLElement* parentElement, const std::string& name);
 
bool hasAttribute(const tinyxml2::XMLElement* element, const char* const name);
 
// Please use getAttributeString() instead.
DART_DEPRECATED(6.0)
std::string getAttribute(tinyxml2::XMLElement* element, const char* const name);
 
// Please use getAttributeDouble() instead.
DART_DEPRECATED(6.0)
void getAttribute(
    tinyxml2::XMLElement* element, const char* const name, double* d);
 
std::string getAttributeString(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
bool getAttributeBool(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
int getAttributeInt(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
unsigned int getAttributeUInt(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
float getAttributeFloat(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
double getAttributeDouble(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
char getAttributeChar(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
Eigen::Vector2i getAttributeVector2i(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
Eigen::Vector2d getAttributeVector2d(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
Eigen::Vector3d getAttributeVector3d(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
Eigen::Vector4d getAttributeVector4d(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
Eigen::Vector6d getAttributeVector6d(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
Eigen::VectorXd getAttributeVectorXd(
    const tinyxml2::XMLElement* element, const std::string& attributeName);
template <std::size_t N>
Eigen::Matrix<double, N, 1> getAttributeVectorNd(
    const tinyxml2::XMLElement* element, const std::string& attributeName)
{
  const std::string val = getAttributeString(element, attributeName);
  return toVectorNd<N>(val);
}
 
template <typename ElementType>
class TemplatedElementEnumerator
{
protected:
  using ElementPtr = ElementType*;
  using ElementRef = ElementType&;
 
public:
  TemplatedElementEnumerator(
      ElementPtr parentElement, const std::string& childElementName)
    : mParentElement(parentElement),
      mChildElementName(childElementName),
      mCurrentElement(nullptr)
  {
  }
 
  ~TemplatedElementEnumerator()
  {
  }
 
  bool next()
  {
    if (!mParentElement)
      return false;
 
    if (mCurrentElement)
    {
      mCurrentElement
          = mCurrentElement->NextSiblingElement(mChildElementName.c_str());
    }
    else
    {
      mCurrentElement
          = mParentElement->FirstChildElement(mChildElementName.c_str());
    }
 
    if (!valid())
      mParentElement = nullptr;
 
    return valid();
  }
 
  ElementPtr get() const
  {
    return mCurrentElement;
  }
 
  ElementPtr operator->() const
  {
    return mCurrentElement;
  }
 
  ElementRef operator*() const
  {
    return *mCurrentElement;
  }
 
  bool operator==(const TemplatedElementEnumerator<ElementType>& rhs) const
  {
    // If they point at the same node, then the names must match
    return (this->mParentElement == rhs.mParentElement)
           && (this->mCurrentElement == rhs.mCurrentElement)
           && (this->mCurrentElement != nullptr
               || (this->mChildElementName == rhs.mChildElementName));
  }
 
  TemplatedElementEnumerator<ElementType>& operator=(
      const TemplatedElementEnumerator<ElementType>& rhs)
  {
    this->mParentElement = rhs.mParentElement;
    this->mChildElementName = rhs.mChildElementName;
    this->mCurrentElement = rhs.mCurrentElement;
 
    return *this;
  }
 
private:
  bool valid() const
  {
    return mCurrentElement != nullptr;
  }
 
private:
  ElementPtr mParentElement;
 
  std::string mChildElementName;
 
  ElementPtr mCurrentElement;
};
 
// ElementEnumerator is for iterating elements for
using ElementEnumerator = TemplatedElementEnumerator<tinyxml2::XMLElement>;
using ConstElementEnumerator
    = TemplatedElementEnumerator<const tinyxml2::XMLElement>;
 
bool copyNode(tinyxml2::XMLNode* destParent, const tinyxml2::XMLNode& src);
 
bool copyChildNodes(
    tinyxml2::XMLNode* destParent, const tinyxml2::XMLNode& src);
 
} // namespace utils
} // namespace dart
 
#endif // #ifndef DART_UTILS_XMLHELPERS_HPP_