List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
casadi::ZipMemResource Class Reference

RAII class for reading from a zip held in memory. More...

#include <resource_internal.hpp>

Detailed Description

Extra doc: https://github.com/casadi/casadi/wiki/L_2cy

Definition at line 141 of file resource_internal.hpp.

Inheritance diagram for casadi::ZipMemResource:
Inheritance graph
[legend]
Collaboration diagram for casadi::ZipMemResource:
Collaboration graph
[legend]

Public Types

using weak_ref_type = WeakRefInternal
 

Public Member Functions

 ZipMemResource (const std::istream &src)
 
 ~ZipMemResource () override
 
const std::string & path () const override
 Get path for a consumer. More...
 
void unpack ()
 
std::string class_name () const override
 Get type name. More...
 
void disp (std::ostream &stream, bool more) const override
 Print description. More...
 
void serialize_body (SerializingStream &s) const override
 
void serialize (SerializingStream &s) const
 
virtual void serialize_type (SerializingStream &s) const
 
void change_option (const std::string &option_name, const GenericType &option_value)
 
casadi_int getCount () const
 Get the reference count. More...
 
std::string debug_repr (const SharedObjectInternal *) const
 
GenericWeakRef< SharedObject, SharedObjectInternal > * weak ()
 Get a weak reference to the object. More...
 

Static Public Member Functions

static ResourceInternal * deserialize (DeserializingStream &s)
 

Protected Member Functions

 ZipMemResource (DeserializingStream &s)
 
void initSingleton ()
 
void destroySingleton ()
 
B shared_from_this ()
 Get a shared object from the current internal object. More...
 
const B shared_from_this () const
 Get a shared object from the current internal object. More...
 

Protected Attributes

std::string serialize_mode_
 

Member Typedef Documentation

◆ weak_ref_type

using casadi::SharedObjectInternal::weak_ref_type = WeakRefInternal
inherited

Definition at line 152 of file shared_object.hpp.

Constructor & Destructor Documentation

◆ ZipMemResource() [1/2]

casadi::ZipMemResource::ZipMemResource ( const std::istream &  src)

Definition at line 107 of file resource_internal.cpp.

108  : ResourceInternal() {
109  blob_ << src.rdbuf();
110  unpack();
111 }
casadi::ResourceInternal::ResourceInternal
ResourceInternal()
Initialize with a path.
Definition: resource_internal.cpp:36

References unpack().

Referenced by deserialize().

◆ ~ZipMemResource()

casadi::ZipMemResource::~ZipMemResource ( )
override

Definition at line 134 of file resource_internal.cpp.

134  {
135  try {
136  casadi_assert_dev(Filesystem::remove_all(dir_));
137  } catch (...) {
138  casadi_warning("Error: Cannot remove temporary directory: " + dir_);
139  }
140  try {
141  casadi_assert_dev(Filesystem::remove(lock_file_));
142  } catch (...) {
143  casadi_warning("Error: Cannot remove lock file: " + lock_file_);
144  }
145 }
casadi::Filesystem::remove_all
static casadi_int remove_all(const std::string &path)
Definition: filesystem.cpp:48
casadi::Filesystem::remove
static bool remove(const std::string &path)
Definition: filesystem.cpp:43

References casadi::Filesystem::remove(), and casadi::Filesystem::remove_all().

◆ ZipMemResource() [2/2]

casadi::ZipMemResource::ZipMemResource ( DeserializingStream &  s)
explicitprotected

Definition at line 202 of file resource_internal.cpp.

202  : ResourceInternal(s) {
203 #ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
204  std::lock_guard<std::mutex> lock(mutex_blob_);
205 #endif // CASADI_WITH_THREADSAFE_SYMBOLICS
206  s.version("ZipMemResource", 1);
207  s.unpack("ZipMemResource::blob", blob_);
208  unpack();
209 }

References unpack(), casadi::DeserializingStream::unpack(), and casadi::DeserializingStream::version().

Member Function Documentation

◆ change_option()

void casadi::ResourceInternal::change_option ( const std::string &  option_name,
const GenericType &  option_value 
)
inherited

Definition at line 53 of file resource_internal.cpp.

54  {
55  if (option_name=="serialize_mode") {
56  serialize_mode_ = option_value.to_string();
57  casadi_assert(serialize_mode_=="embed" || serialize_mode_=="link",
58  "Invalid serialization mode: " + serialize_mode_ + ". Pick 'link' or 'embed'.");
59  } else {
60  casadi_error("Option '" + option_name + "' does not exist");
61  }
62 }

References casadi::ResourceInternal::serialize_mode_, and casadi::GenericType::to_string().

◆ class_name()

std::string casadi::ZipMemResource::class_name ( ) const
inlineoverridevirtual

Extra doc: https://github.com/casadi/casadi/wiki/L_2d5

Implements casadi::SharedObjectInternal.

Definition at line 152 of file resource_internal.hpp.

152 {return "ZipMemResource";}

◆ debug_repr()

std::string casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::debug_repr ( const Internal *  i) const
inherited

Definition at line 62 of file generic_shared_internal.hpp.

162  {
163  // Note: i != this because of something something multiple inheritance
164  return str( (casadi_int)(i)) + "/" + static_cast<const Internal*>(this)->class_name();
165  }
casadi::str
std::string str(const T &v)
String representation, any type.
Definition: casadi_common.hpp:247

◆ deserialize()

ResourceInternal * casadi::ZipMemResource::deserialize ( DeserializingStream &  s)
static

Definition at line 186 of file resource_internal.cpp.

186  {
187 ZipMemResource* ret = new ZipMemResource(s);
188  return ret;
189 }
casadi::ZipMemResource::ZipMemResource
ZipMemResource(const std::istream &src)
Definition: resource_internal.cpp:107

References ZipMemResource().

Referenced by casadi::ResourceInternal::deserialize().

◆ destroySingleton()

void casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::destroySingleton ( )
inlineprotectedinherited

Called in the destructor of singletons

Definition at line 77 of file generic_shared_internal.hpp.

77  {
78  static_cast<Internal*>(this)->count--;
79  }

◆ disp()

void casadi::ZipMemResource::disp ( std::ostream &  stream,
bool  more 
) const
overridevirtual

Implements casadi::SharedObjectInternal.

Definition at line 117 of file resource_internal.cpp.

117  {
118  stream << "ZipMemResource(blob) -> \"" << dir_ << "\"";
119 }

◆ getCount()

casadi_int casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::getCount
inherited

Definition at line 60 of file generic_shared_internal.hpp.

186  {
187  return static_cast<const Internal*>(this)->count;
188  }

◆ initSingleton()

void casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::initSingleton ( )
inlineprotectedinherited

Called in the constructor of singletons to avoid that the counter reaches zero

Definition at line 71 of file generic_shared_internal.hpp.

71  {
72  casadi_assert_dev(static_cast<Internal*>(this)->count==0);
73  static_cast<Internal*>(this)->count++;
74  }

◆ path()

const std::string& casadi::ZipMemResource::path ( ) const
inlineoverridevirtual

Implements casadi::ResourceInternal.

Definition at line 146 of file resource_internal.hpp.

146 {return dir_;}

◆ serialize()

void casadi::ResourceInternal::serialize ( SerializingStream &  s) const
inherited

Definition at line 147 of file resource_internal.cpp.

147  {
148  s.version("ResourceInternal", 1);
149  serialize_type(s);
150  serialize_body(s);
151 }
casadi::ResourceInternal::serialize_body
virtual void serialize_body(SerializingStream &s) const
Definition: resource_internal.cpp:157
casadi::ResourceInternal::serialize_type
virtual void serialize_type(SerializingStream &s) const
Definition: resource_internal.cpp:153

References casadi::ResourceInternal::serialize_body(), casadi::ResourceInternal::serialize_type(), and casadi::SerializingStream::version().

◆ serialize_body()

void casadi::ZipMemResource::serialize_body ( SerializingStream &  s) const
overridevirtual

Reimplemented from casadi::ResourceInternal.

Definition at line 274 of file resource_internal.cpp.

274  {
275 #ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
276  std::lock_guard<std::mutex> lock(mutex_blob_);
277 #endif // CASADI_WITH_THREADSAFE_SYMBOLICS
278  ResourceInternal::serialize_body(s);
279  s.version("ZipMemResource", 1);
280  s.pack("ZipMemResource::blob", blob_);
281 
282  // rewind
283  blob_.clear();
284  blob_.seekg(0, std::ios::beg);
285 }

References casadi::SerializingStream::pack(), casadi::ResourceInternal::serialize_body(), and casadi::SerializingStream::version().

◆ serialize_type()

void casadi::ResourceInternal::serialize_type ( SerializingStream &  s) const
virtualinherited

Reimplemented in casadi::ZipResource, and casadi::DirResource.

Definition at line 153 of file resource_internal.cpp.

153  {
154  s.pack("ResourceInternal::type", class_name());
155 }
casadi::SharedObjectInternal::class_name
virtual std::string class_name() const =0
Readable name of the internal class.

References casadi::SharedObjectInternal::class_name(), and casadi::SerializingStream::pack().

Referenced by casadi::ResourceInternal::serialize().

◆ shared_from_this() [1/2]

B casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::shared_from_this ( )
inlineprotectedinherited

Definition at line 83 of file generic_shared_internal.hpp.

83  {
84  casadi_assert_dev(B::test_cast(static_cast<Internal*>(this)));
85  B ret;
86  ret.own(static_cast<Internal*>(this));
87  return ret;
88  }

◆ shared_from_this() [2/2]

const B casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::shared_from_this ( ) const
inlineprotectedinherited

Definition at line 92 of file generic_shared_internal.hpp.

92  {
93  casadi_assert_dev(B::test_cast(static_cast<const Internal*>(this)));
94  B ret;
95  ret.own(const_cast<Internal*>(static_cast<const Internal*>(this)));
96  return ret;
97  }

◆ unpack()

void casadi::ZipMemResource::unpack ( )

Definition at line 87 of file resource_internal.cpp.

87  {
88  std::string zip_file = "zip";
89  lock_file_ = Filesystem::absolute(temporary_file(zip_file + ".", ".lock"));
90  dir_ = lock_file_.substr(0, lock_file_.size()-5) + ".unzipped";
91  casadi_assert(Archiver::has_plugin("libzip"),
92  "Unzipping stream requires libzip. Compile CasADi with WITH_LIBZIP=ON.\n"
93  "Alternatively, save with serialize option set to link. ");
94 
95  Archiver::getPlugin("libzip").exposed.unpack_from_stringstream(blob_, dir_);
96  // rewind
97  blob_.clear();
98  blob_.seekg(0, std::ios::beg);
99 }
casadi::Filesystem::absolute
static std::string absolute(const std::string &path)
Definition: filesystem.cpp:78
casadi::PluginInterface< Archiver >::has_plugin
static bool has_plugin(const std::string &pname, bool verbose=false)
Check if a plugin is available or can be loaded.
Definition: plugin_interface.hpp:131
casadi::PluginInterface< Archiver >::getPlugin
static Plugin & getPlugin(const std::string &pname)
Load and get the creator function.
Definition: plugin_interface.hpp:291
casadi::temporary_file
std::string temporary_file(const std::string &prefix, const std::string &suffix)
Definition: casadi_misc.cpp:353

References casadi::Filesystem::absolute(), casadi::PluginInterface< Archiver >::getPlugin(), casadi::PluginInterface< Archiver >::has_plugin(), and casadi::temporary_file().

Referenced by ZipMemResource().

◆ weak()

GenericWeakRef< SharedObject , SharedObjectInternal > * casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::weak
inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_1ai

Definition at line 67 of file generic_shared_internal.hpp.

191  {
192  if (weak_ref_==nullptr) {
193  weak_ref_ = new GenericWeakRef<Shared, Internal>(static_cast<Internal*>(this));
194  }
195  return weak_ref_;
196  }

Member Data Documentation

◆ serialize_mode_

std::string casadi::ResourceInternal::serialize_mode_
protectedinherited

Definition at line 63 of file resource_internal.hpp.

Referenced by casadi::ResourceInternal::change_option(), casadi::ResourceInternal::ResourceInternal(), casadi::ResourceInternal::serialize_body(), casadi::DirResource::serialize_body(), casadi::ZipResource::serialize_body(), casadi::DirResource::serialize_type(), and casadi::ZipResource::serialize_type().

The documentation for this class was generated from the following files: