importer_internal.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_INTERNAL_HPP
#define CASADI_IMPORTER_INTERNAL_HPP
 
#include "importer.hpp"
#include "function_internal.hpp"
#include "plugin_interface.hpp"
 
 
namespace casadi {
 
  class CASADI_EXPORT
  ImporterInternal : public SharedObjectInternal,
                     public PluginInterface<ImporterInternal> {
 
  public:
    explicit ImporterInternal(const std::string& name);
 
    ~ImporterInternal() override;
 
    std::string class_name() const override { return "ImporterInternal";}
 
    void disp(std::ostream& stream, bool more) const override;
 
    // Creator function for internal class
    typedef ImporterInternal* (*Creator)(const std::string& name);
 
    void construct(const Dict& opts);
 
 
    static const Options options_;
    virtual const Options& get_options() const { return options_;}
 
    virtual void init(const Dict& opts);
 
    virtual void finalize() {}
 
    // No static functions exposed
    struct Exposed{ };
 
    static std::map<std::string, Plugin> solvers_;
 
#ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
    static std::mutex mutex_solvers_;
#endif // CASADI_WITH_THREADSAFE_SYMBOLICS
 
    static const std::string infix_;
 
    static std::string shortname() { return "importer";}
 
    const char* plugin_name() const override { return "none";}
 
    virtual signal_t get_function(const std::string& symname) { return nullptr;}
 
    bool has_function(const std::string& symname) const;
 
    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;
 
    void read_meta(std::istream& file, casadi_int& offset);
 
    void read_external(const std::string& sym, bool inlined,
                       std::istream& file, casadi_int& offset);
 
    // Check if a function is inlined
    bool inlined(const std::string& symname) const;
 
    std::string body(const std::string& symname) const;
 
    virtual std::string library() const;
 
    virtual bool can_have_meta() const { return true;}
 
    std::string to_text(const std::string& cmd, casadi_int ind=-1) const;
 
    static inline std::string indexed(const std::string& cmd, casadi_int ind) {
      std::stringstream ss;
      ss << cmd << "[" << ind << "]";
      return ss.str();
    }
 
    std::string name_;
 
    std::map<std::string, std::pair<casadi_int, std::string> > meta_;
 
    std::map<std::string, std::pair<bool, std::string> > external_;
 
    bool verbose_;
 
    void serialize(SerializingStream& s) const;
 
    virtual void serialize_type(SerializingStream& s) const;
    virtual void serialize_body(SerializingStream& s) const;
 
    static ImporterInternal* deserialize(DeserializingStream& s);
 
  protected:
    explicit ImporterInternal(DeserializingStream& s);
  };
 
  class CASADI_EXPORT
  DllLibrary : public ImporterInternal {
  private:
#if defined(WITH_DL) && defined(_WIN32) // also for 64-bit
    typedef HINSTANCE handle_t;
#else
    typedef void* handle_t;
#endif
    handle_t handle_;
  public:
 
    // Constructor
    explicit DllLibrary(const std::string& bin_name);
 
    void finalize() override;
 
    void init_handle();
 
    // Destructor
    ~DllLibrary() override;
 
    std::string class_name() const override { return "DllLibrary";}
 
    // Dummy type
    signal_t get_function(const std::string& symname) override;
 
    std::string library() const override;
 
    bool can_have_meta() const override { return false;}
 
    static ImporterInternal* deserialize(DeserializingStream& s);
 
  protected:
    explicit DllLibrary(DeserializingStream& s) : ImporterInternal(s) {}
  };
 
} // namespace casadi
#endif // CASADI_IMPORTER_INTERNAL_HPP