XmlPropertyReader.cpp

Go to the documentation of this file.

// Copyright 2002-2021 CEA LIST
// SPDX-FileCopyrightText: 2022 CEA LIST <gael.de-chalendar@cea.fr>
//
// SPDX-License-Identifier: MIT
 
#include "XmlPropertyReader.h"
#include "common/LimaCommon.h"
 
#include <QXmlStreamReader>
 
namespace Lima
{
namespace Common
{
namespace PropertyCode
{
 
class XmlPropertyReaderPrivate
{
  friend class XmlPropertyReader;
 
public:
  // -----------------------------------------------------------------------
  //  Constructors
  // -----------------------------------------------------------------------
  XmlPropertyReaderPrivate();
  ~XmlPropertyReaderPrivate() = default;
 
  bool parse(QIODevice *device);
  void readLinguisticCodes();
  void readProperty();
  void readValue();
  void readSubProperty();
  void readSubValues();
  void readSubValue();
 
  QXmlStreamReader m_reader;
  std::vector<XmlPropertyReader::PropertyDescription> m_properties;
  std::vector<XmlPropertyReader::SubPropertyDescription> m_subproperties;
};
 
XmlPropertyReaderPrivate::XmlPropertyReaderPrivate()
{
}
 
XmlPropertyReader::XmlPropertyReader() : m_d(new XmlPropertyReaderPrivate())
{
}
 
XmlPropertyReader::~XmlPropertyReader()
{
  delete m_d;
}
 
bool XmlPropertyReader::parse(QIODevice *device)
{
  return m_d->parse(device);
}
 
// <?xml version='1.0' encoding='UTF-8'?>
// <Linguistic_codes>
//   <property name="GENDER">
//     <value name="MASC"/>
//     …
//   </property>
//   <subproperty name="MICRO" parent="MACRO">
//     <subvalues value="ADJ">
//       <value name="ADJ"/>
//     </subvalues>
//    …
//   </subproperty>
//   …
// </Linguistic_codes>
bool XmlPropertyReaderPrivate::parse(QIODevice *device)
{
#ifdef DEBUG_LP
  PROPERTYCODELOGINIT;
  LDEBUG << "XmlPropertyReaderPrivate::parse";
#endif
  m_reader.setDevice(device);
  if (m_reader.readNextStartElement()) {
      if (m_reader.name() == QLatin1String("Linguistic_codes"))
      {
          readLinguisticCodes();
      }
      else
      {
          m_reader.raiseError(QObject::tr("The file is not a LIMA XML linguistic properties codes file."));
      }
  }
  return !m_reader.error();
}
 
// <Linguistic_codes>
//   <property name="GENDER">
//     …
//   </property>
//   <subproperty name="MICRO" parent="MACRO">
//    …
//   </subproperty>
//   …
// </Linguistic_codes>
void XmlPropertyReaderPrivate::readLinguisticCodes()
{
  PROPERTYCODELOGINIT;
  LTRACE << "XmlPropertyReaderPrivate::readLinguisticCodes" << m_reader.name();
  Q_ASSERT(m_reader.isStartElement() && m_reader.name() == QLatin1String("Linguistic_codes"));
 
  while (m_reader.readNextStartElement())
  {
      if (m_reader.name() == QLatin1String("property"))
          readProperty();
      else if (m_reader.name() == QLatin1String("subproperty"))
          readSubProperty();
      else
          m_reader.raiseError(QObject::tr("Expected a property or subproperty but got a %1.").arg(m_reader.name()));
  }
#ifdef DEBUG_LP
  LTRACE << "XmlPropertyReaderPrivate::readLinguisticCodes OUT";
#endif
}
 
//   <property name="GENDER">
//     <value name="MASC"/>
//     …
//   </property>
void XmlPropertyReaderPrivate::readProperty()
{
#ifdef DEBUG_LP
  PROPERTYCODELOGINIT;
  LTRACE << "XmlPropertyReaderPrivate::readProperty" << m_reader.name() << m_reader.attributes().value("name");
#endif
  Q_ASSERT(m_reader.isStartElement() && m_reader.name() == QLatin1String("property"));
  m_properties.push_back(XmlPropertyReader::PropertyDescription());
  m_properties.back().name = m_reader.attributes().value("name").toUtf8().data();
  while (m_reader.readNextStartElement())
  {
      if (m_reader.name() == QLatin1String("value"))
          readValue();
      else
          m_reader.raiseError(QObject::tr("Expected a value but got a %1.").arg(m_reader.name()));
  }
#ifdef DEBUG_LP
  LTRACE << "XmlPropertyReaderPrivate::readProperty OUT";
#endif
}
 
//     <value name="MASC"/>
void XmlPropertyReaderPrivate::readValue()
{
#ifdef DEBUG_LP
  PROPERTYCODELOGINIT;
  LTRACE << "XmlPropertyReaderPrivate::readValue" << m_reader.name() << m_reader.attributes().value("name");
#endif
  Q_ASSERT(m_reader.isStartElement() && m_reader.name() == QLatin1String("value"));
  auto value = m_reader.attributes().value("name").toString().toStdString();
  m_properties.back().values.push_back(value);
  m_reader.skipCurrentElement();
#ifdef DEBUG_LP
  LTRACE << "XmlPropertyReaderPrivate::readValue OUT";
#endif
}
 
//   <subproperty name="MICRO" parent="MACRO">
//     <subvalues value="ADJ">
//     …
//     </subvalues>
//    …
//   </subproperty>
void XmlPropertyReaderPrivate::readSubProperty()
{
#ifdef DEBUG_LP
  PROPERTYCODELOGINIT;
  LTRACE << "XmlPropertyReaderPrivate::readSubProperty" << m_reader.name() << m_reader.attributes().value("name");
#endif
  Q_ASSERT(m_reader.isStartElement() && m_reader.name() == QLatin1String("subproperty"));
  m_subproperties.push_back(XmlPropertyReader::SubPropertyDescription());
  m_subproperties.back().name = m_reader.attributes().value("name").toString().toStdString();
  m_subproperties.back().parentName = m_reader.attributes().value("parent").toString().toStdString();
#ifdef DEBUG_LP
  LDEBUG << "read subproperty " << m_subproperties.back().name << " of parent property " << m_subproperties.back().parentName;
#endif
  while (m_reader.readNextStartElement()) {
      if (m_reader.name() == QLatin1String("subvalues"))
          readSubValues();
      else
          m_reader.raiseError(QObject::tr("Expected a subvalues but got a %1.").arg(m_reader.name()));
  }
}
 
//     <subvalues value="ADJ">
//       <value name="ADJ"/>
//       …
//     </subvalues>
void XmlPropertyReaderPrivate::readSubValues()
{
#ifdef DEBUG_LP
  PROPERTYCODELOGINIT;
  LTRACE << "XmlPropertyReaderPrivate::readSubValues" << m_reader.name();
#endif
  Q_ASSERT(m_reader.isStartElement() && m_reader.name() == QLatin1String("subvalues"));
  auto value = m_reader.attributes().value("value").toString().toStdString();
#ifdef DEBUG_LP
  LDEBUG << "XmlPropertyReaderPrivate::readSubValues" << value;
#endif
  m_subproperties.back().values.push_back(make_pair(value, std::vector<std::string>()));
  while (m_reader.readNextStartElement()) {
      if (m_reader.name() == QLatin1String("value"))
          readSubValue();
      else
          m_reader.raiseError(QObject::tr("Expected a subvalues but got a %1.").arg(m_reader.name()));
  }
}
 
//       <value name="ADJ"/>
void XmlPropertyReaderPrivate::readSubValue()
{
#ifdef DEBUG_LP
  PROPERTYCODELOGINIT;
  LTRACE << "XmlPropertyReaderPrivate::readSubValue" << m_reader.name();
#endif
  Q_ASSERT(m_reader.isStartElement() && m_reader.name() == QLatin1String("value"));
  auto value = m_reader.attributes().value("name").toString();
  m_reader.skipCurrentElement();
#ifdef DEBUG_LP
  LDEBUG << "XmlPropertyReaderPrivate::readSubValue" << value;
#endif
  m_subproperties.back().values.back().second.push_back(value.toStdString());
}
 
 
QString XmlPropertyReader::errorString() const
{
  PROPERTYCODELOGINIT;
  auto errorStr = QObject::tr("%1, Line %2, column %3")
          .arg(m_d->m_reader.errorString())
          .arg(m_d->m_reader.lineNumber())
          .arg(m_d->m_reader.columnNumber());
  LERROR << errorStr;
  return errorStr;
}
 
 
const std::vector<XmlPropertyReader::PropertyDescription>& XmlPropertyReader::getProperties()
{
  return m_d->m_properties;
}
 
const std::vector<XmlPropertyReader::SubPropertyDescription>& XmlPropertyReader::getSubProperties()
{
  return m_d->m_subproperties;
}
 
} // closing namespace PropertyCode
} // closing namespace Common
} // closing namespace Lima