importer.hpp

/*
 *    This file is part of CasADi.
 *
 *    CasADi -- A symbolic framework for dynamic optimization.
 *    Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
 *                            KU Leuven. All rights reserved.
 *    Copyright (C) 2011-2014 Greg Horn
 *
 *    CasADi is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    CasADi 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
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with CasADi; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
 
 
#ifndef CASADI_IMPORTER_HPP
#define CASADI_IMPORTER_HPP
 
#include "function.hpp"
#include "printable.hpp"
 
namespace casadi {
 
#ifndef SWIG
    template<typename T>
    T text2type(const std::string& text) {
      std::istringstream ss(text);
      T ret;
      ss >> ret;
      return ret;
    }
 
    template<typename T>
    std::vector<T> text2vector(const std::string& text) {
      std::istringstream ss(text);
      T tmp;
      std::vector<T> ret;
      while (ss >> tmp) ret.push_back(tmp);
      return ret;
    }
 
    template<typename T>
    std::set<T> text2set(const std::string& text) {
      std::vector<T> v = text2vector<T>(text);
      std::set<T> ret;
      for (auto&& i : v) ret.insert(i);
      return ret;
    }
#endif // SWIG
 
  // Forward declaration of internal class
  class ImporterInternal;
 
  class CASADI_EXPORT Importer
    : public SharedObject,
      public SWIG_IF_ELSE(PrintableCommon, Printable<Importer>) {
  public:
    static std::string type_name() {return "Importer";}
 
    Importer();
 
    explicit Importer(const std::string& name,
                      const std::string& compiler,
                      const Dict& opts=Dict());
 
    ImporterInternal* operator->();
    const ImporterInternal* operator->() const;
 
    static bool test_cast(const SharedObjectInternal* ptr);
 
    static bool has_plugin(const std::string& name);
 
    static void load_plugin(const std::string& name);
 
    static std::string doc(const std::string& name);
 
    std::string plugin_name() const;
 
    // Check if symbol exists
    bool has_function(const std::string& symname) const;
 
#ifndef SWIG
    signal_t get_function(const std::string& symname);
#endif // SWIG
 
#ifndef SWIG
    static Importer create(ImporterInternal* node);
 
    static Importer create(ImporterInternal* node, const Dict& opts);
#endif // SWIG
 
    bool has_meta(const std::string& cmd, casadi_int ind=-1) const;
 
    std::string get_meta(const std::string& cmd, casadi_int ind=-1) const;
 
    bool inlined(const std::string& symname) const;
 
    std::string body(const std::string& symname) const;
 
    std::string library() const;
 
#ifndef SWIG
    static inline std::string indexed(const std::string& cmd, casadi_int ind) {
      std::stringstream ss;
      ss << cmd << "[" << ind << "]";
      return ss.str();
    }
 
    template<typename T>
    T to(const std::string& cmd, casadi_int ind=-1) const {
      return text2type<T>(get_meta(cmd, ind));
    }
 
    std::string meta_string(const std::string& cmd, casadi_int ind=-1) const {
      return to<std::string>(cmd, ind);
    }
 
    template<typename T>
    std::vector<T> meta_vector(const std::string& cmd, casadi_int ind=-1) const {
      return text2vector<T>(get_meta(cmd, ind));
    }
 
    template<typename T>
    std::set<T> meta_set(const std::string& cmd, casadi_int ind=-1) const {
      return text2set<T>(get_meta(cmd, ind));
    }
 
    casadi_int meta_int(const std::string& cmd, casadi_int ind=-1) const {
      return to<casadi_int>(cmd, ind);
    }
#endif // SWIG
 
    void serialize(SerializingStream &s) const;
 
    static Importer deserialize(DeserializingStream& s);
  };
 
} // namespace casadi
 
#endif // CASADI_IMPORTER_HPP