FileTranslatorBase.h

Go to the documentation of this file.

#pragma once
//----------------------------------------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------------------------------------
#include "AL/maya/FileTranslatorOptions.h"

#include "maya/MPxFileTranslator.h"
#include "maya/MGlobal.h"
#include "maya/MFileObject.h"

namespace AL {
namespace maya {

#define AL_MAYA_TRANSLATOR_BEGIN(ClassName, TranslatorName, HaveRead, HaveWrite, DefaultExtension, FilterString) \
  class ClassName : public AL::maya::FileTranslatorBase<ClassName> { \
  public: \
    static constexpr const char* const kTranslatorName = TranslatorName; \
    static constexpr const char* const kClassName = #ClassName; \
    static void* creator() { return new ClassName; } \
  private: \
    bool haveReadMethod() const { return HaveRead; } \
    bool haveWriteMethod() const { return HaveWrite; } \
    MString defaultExtension() const { return DefaultExtension; } \
    MString filter() const { return FilterString; } \
  public:

#define AL_MAYA_TRANSLATOR_END() };

//----------------------------------------------------------------------------------------------------------------------
//----------------------------------------------------------------------------------------------------------------------
template<typename T>
class FileTranslatorBase
  : public MPxFileTranslator
{
public:

  template<typename FnPlugin>
  static MStatus registerTranslator(FnPlugin& plugin)
    {
      FileTranslatorOptions options(T::kClassName);
      if(MS::kSuccess == T::specifyOptions(options))
      {
        options.generateScript(m_optionParser, m_defaultOptionString);

        MStatus status = plugin.registerFileTranslator(
            T::kTranslatorName,
            "",
            T::creator,
            T::kClassName,
            m_defaultOptionString.asChar());

        if(!status) {
          MGlobal::displayError(MString("Failed to register translator: ") + T::kTranslatorName);
        }
        return status;
      }
      MGlobal::displayError(MString("Failed to generate options for translator: ") + T::kTranslatorName);
      return MS::kFailure;
    }

  template<typename FnPlugin>
  static MStatus deregisterTranslator(FnPlugin& plugin)
    { return plugin.deregisterFileTranslator(T::kTranslatorName); }

  static MStatus specifyOptions(FileTranslatorOptions& options)
    { return MS::kSuccess; }

  virtual MStatus reader(const MFileObject& file, const OptionsParser& options, FileAccessMode mode)
    { return MS::kFailure; }

  virtual MStatus writer(const MFileObject& file, const OptionsParser& options, FileAccessMode mode)
    { return MS::kFailure; }

private:

  MStatus reader(const MFileObject &file, const MString &optionsString, const FileAccessMode mode) override
    {
      MStatus status = m_optionParser.parse(optionsString);
      if(MS::kSuccess == status)
      {
        return reader(file, m_optionParser, mode);
      }
      MGlobal::displayError("Unable to parse the file translator options");
      return status;
    }

  MStatus writer(const MFileObject &file, const MString &optionsString, const FileAccessMode mode) override
    {
      MStatus status = m_optionParser.parse(optionsString);
      if(MS::kSuccess == status)
      {
        return writer(file, m_optionParser, mode);
      }
      MGlobal::displayError("Unable to parse the file translator options");
      return status;
    }

  static MString m_defaultOptionString;
  static OptionsParser m_optionParser;
};

template<typename T> MString FileTranslatorBase<T>::m_defaultOptionString;
template<typename T> OptionsParser FileTranslatorBase<T>::m_optionParser;

//----------------------------------------------------------------------------------------------------------------------
} // usdmaya
} // AL
//----------------------------------------------------------------------------------------------------------------------