GyotoRegister.h

Go to the documentation of this file.

/*
    Copyright 2011-2016 Thibaut Paumard

    This file is part of Gyoto.

    Gyoto is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Gyoto is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Gyoto.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __GyotoRegister_H_
#define __GyotoRegister_H_

#include <string>
#include "GyotoSmartPointer.h"

namespace Gyoto {
  namespace Register {

    /* Documented below */
    class Entry;

    void init( char const * pluglist = NULL );

    void list();
  }

  void * loadPlugin(   char const * const plugname, int nofail = 0);

  bool havePlugin(std::string plugname);

  void requirePlugin(std::string plugname, int nofail = 0);
}

class Gyoto::Register::Entry {
  friend void Gyoto::Register::list();
protected:
  std::string name_;
  Gyoto::SmartPointee::Subcontractor_t* subcontractor_;
  Register::Entry* next_;
  const std::string plugin_;
public:
  Entry(std::string name,
                Gyoto::SmartPointee::Subcontractor_t* subcontractor,
                Entry* next);
  ~Entry(); 

  Gyoto::SmartPointee::Subcontractor_t*
    getSubcontractor(std::string name, std::string &plugin, int errmode=0);

};

#define GYOTO_GETSUBCONTRACTOR(space)           \
  Gyoto::space::Subcontractor_t*                                        \
  Gyoto::space::getSubcontractor(std::string name, std::vector<std::string> &plugin, int errmode) { \
  for (size_t i=0; i<plugin.size(); ++i) {                              \
    GYOTO_DEBUG_EXPR(plugin[i]);                                        \
    Gyoto::requirePlugin(plugin[i]);                                    \
  }                                                                     \
  if (!Gyoto::space::Register_) throwError("No " GYOTO_STRINGIFY(space) " kind registered!"); \
  Subcontractor_t* sctr= NULL;                                          \
  std::string plg("");                                                  \
  if (!plugin.size()) {                                                 \
  sctr =                                                                \
    (Subcontractor_t*)Gyoto::space::Register_                           \
    -> getSubcontractor(name, plg, errmode);                            \
  plugin.push_back(plg);                                                \
  }                                                                     \
  for (size_t i=plugin.size()-1; i>=0 && sctr == NULL; --i) {           \
    sctr=                                                               \
      (Subcontractor_t*)Gyoto::space::Register_                         \
      -> getSubcontractor(name, plugin[i], 1);                          \
  }                                                                     \
  if (!errmode && !sctr) throwError ("Kind not found in the specified plug-ins: "+name); \
  return sctr;                                                          \
}

#endif