XmlIo.h

Go to the documentation of this file.

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef MATERIALX_XMLIO_H
#define MATERIALX_XMLIO_H
 
 
#include <MaterialXCore/Library.h>
 
#include <MaterialXCore/Document.h>
 
#include <MaterialXFormat/Export.h>
#include <MaterialXFormat/File.h>
 
MATERIALX_NAMESPACE_BEGIN
 
class XmlReadOptions;
 
extern MX_FORMAT_API const string MTLX_EXTENSION;
 
using XmlReadFunction = std::function<void(DocumentPtr, const FilePath&, const FileSearchPath&, const XmlReadOptions*)>;
 
class MX_FORMAT_API XmlReadOptions
{
  public:
    XmlReadOptions();
    ~XmlReadOptions() { }
 
    bool readComments;
 
    bool readNewlines;
 
    bool upgradeVersion;
 
    XmlReadFunction readXIncludeFunction;
 
    StringVec parentXIncludes;
};
 
class MX_FORMAT_API XmlWriteOptions
{
  public:
    XmlWriteOptions();
    ~XmlWriteOptions() { }
 
    bool writeXIncludeEnable;
 
    ElementPredicate elementPredicate;
};
 
class MX_FORMAT_API ExceptionParseError : public Exception
{
  public:
    using Exception::Exception;
};
 
class MX_FORMAT_API ExceptionFileMissing : public Exception
{
  public:
    using Exception::Exception;
};
 
 
MX_FORMAT_API void readFromXmlBuffer(DocumentPtr doc, const char* buffer, FileSearchPath searchPath = FileSearchPath(), const XmlReadOptions* readOptions = nullptr);
 
MX_FORMAT_API void readFromXmlStream(DocumentPtr doc, std::istream& stream, FileSearchPath searchPath = FileSearchPath(), const XmlReadOptions* readOptions = nullptr);
 
MX_FORMAT_API void readFromXmlFile(DocumentPtr doc,
                                   FilePath filename,
                                   FileSearchPath searchPath = FileSearchPath(),
                                   const XmlReadOptions* readOptions = nullptr);
 
MX_FORMAT_API void readFromXmlString(DocumentPtr doc, const string& str, const FileSearchPath& searchPath = FileSearchPath(), const XmlReadOptions* readOptions = nullptr);
 
 
MX_FORMAT_API void writeToXmlStream(DocumentPtr doc, std::ostream& stream, const XmlWriteOptions* writeOptions = nullptr);
 
MX_FORMAT_API void writeToXmlFile(DocumentPtr doc, const FilePath& filename, const XmlWriteOptions* writeOptions = nullptr);
 
MX_FORMAT_API string writeToXmlString(DocumentPtr doc, const XmlWriteOptions* writeOptions = nullptr);
 
 
MX_FORMAT_API void prependXInclude(DocumentPtr doc, const FilePath& filename);
 
 
MATERIALX_NAMESPACE_END
 
#endif