shell_compiler.hpp
1 /*
2  * This file is part of CasADi.
3  *
4  * CasADi -- A symbolic framework for dynamic optimization.
5  * Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
6  * KU Leuven. All rights reserved.
7  * Copyright (C) 2011-2014 Greg Horn
8  *
9  * CasADi is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 3 of the License, or (at your option) any later version.
13  *
14  * CasADi is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with CasADi; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  *
23  */
24 
25 
26 #ifndef CASADI_SHELL_INTERFACE_HPP
27 #define CASADI_SHELL_INTERFACE_HPP
28 
29 #include "casadi/core/importer_internal.hpp"
30 #include <casadi/solvers/casadi_importer_shell_export.h>
31 #include "casadi/core/plugin_interface.hpp"
32 
43 namespace casadi {
53  class ShellCompiler : public ImporterInternal {
54  public:
55 
57  explicit ShellCompiler(const std::string& name);
58 
60  static ImporterInternal* creator(const std::string& name) {
61  return new ShellCompiler(name);
62  }
63 
65  ~ShellCompiler() override;
66 
68 
69  static const Options options_;
70  const Options& get_options() const override { return options_;}
72 
74  void init(const Dict& opts) override;
75 
77  static const std::string meta_doc;
78 
80  const char* plugin_name() const override { return "shell";}
81 
82  // Get name of the class
83  std::string class_name() const override { return "ShellCompiler";}
84 
86  signal_t get_function(const std::string& symname) override;
87 
89  std::string library() const override;
90 
91  protected:
92  std::string base_name_;
93 
95  std::string bin_name_;
96 
98  std::string obj_name_;
99 
101  std::vector<std::string> extra_suffixes_;
102 
104  bool cleanup_;
105 
106  // Shared library handle
107  handle_t handle_;
108  };
109 
110 } // namespace casadi
112 
113 #endif // CASADI_SHELL_INTERFACE_HPP
The casadi namespace.
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.