archiver_impl.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_ARCHIVER_IMPL_HPP
27 #define CASADI_ARCHIVER_IMPL_HPP
28 
29 #include "archiver.hpp"
30 #include "plugin_interface.hpp"
31 #include <iostream>
32 #include <vector>
33 #include <utility>
34 
36 namespace casadi {
37 
47  class CASADI_EXPORT
48  Archiver : public PluginInterface<Archiver> {
49  public:
50  typedef bool (* Unpack)(const std::string& src,
51  const std::string& target_dir);
52  typedef bool (* UnpackFromStringStream)(std::stringstream& src,
53  const std::string& target_dir);
54  typedef bool (* Pack)(const std::string& src_dir,
55  const std::string& path);
56  typedef bool (* PackToStream)(const std::string& src_dir,
57  std::ostream& src);
58  // Pack an explicit set of {file_path -> archive_name} entries (no staging directory)
59  typedef bool (* PackEntries)(
60  const std::vector<std::pair<std::string, std::string> >& entries,
61  const std::string& path);
62 
63  // Creator function for internal class
64  typedef Archiver* (*Creator)();
65 
66  static const std::string meta_doc;
67 
68  // No static functions exposed
69  struct Exposed{
70  Unpack unpack;
71  UnpackFromStringStream unpack_from_stringstream;
72  Pack pack;
73  PackToStream pack_to_stream;
74  PackEntries pack_entries;
75  };
76 
78  static std::map<std::string, Plugin> solvers_;
79 
80 #ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
81  static std::mutex mutex_solvers_;
82 #endif // CASADI_WITH_THREADSAFE_SYMBOLICS
83 
85  static const std::string infix_;
86  };
87 
88 } // namespace casadi
89 
91 
92 #endif // CASADI_ARCHIVER_IMPL_HPP
The casadi namespace.
Definition: archiver.hpp:32