10 changed files with 666 additions and 3 deletions
@ -0,0 +1,130 @@
|
||||
.. |
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 |
||||
Vladimír Vondruš <mosra@centrum.cz> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a |
||||
copy of this software and associated documentation files (the "Software"), |
||||
to deal in the Software without restriction, including without limitation |
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||
and/or sell copies of the Software, and to permit persons to whom the |
||||
Software is furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included |
||||
in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||
DEALINGS IN THE SOFTWARE. |
||||
.. |
||||
|
||||
.. py:class:: magnum.trade.ImageData1D |
||||
|
||||
See `ImageData2D` for more information. |
||||
|
||||
.. py:class:: magnum.trade.ImageData2D |
||||
|
||||
Similarly to `Image2D`, holds its own data buffer, thus doesn't have an |
||||
equivalent to `ImageView2D.owner`. Implicitly convertible to `ImageView2D` |
||||
/ `MutableImageView2D`, so all APIs consuming image views work with this |
||||
type as well. |
||||
|
||||
.. py:class:: magnum.trade.ImageData3D |
||||
|
||||
See `ImageData2D` for more information. |
||||
|
||||
.. py:property:: magnum.trade.ImageData1D.storage |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
.. py:property:: magnum.trade.ImageData2D.storage |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
.. py:property:: magnum.trade.ImageData3D.storage |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
|
||||
.. py:property:: magnum.trade.ImageData1D.format |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
.. py:property:: magnum.trade.ImageData2D.format |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
.. py:property:: magnum.trade.ImageData3D.format |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
|
||||
.. py:property:: magnum.trade.ImageData1D.pixel_size |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
.. py:property:: magnum.trade.ImageData2D.pixel_size |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
.. py:property:: magnum.trade.ImageData3D.pixel_size |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
|
||||
.. py:property:: magnum.trade.ImageData1D.pixels |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
.. py:property:: magnum.trade.ImageData2D.pixels |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
.. py:property:: magnum.trade.ImageData3D.pixels |
||||
:raise AttributeError: If `is_compressed` is :py:`True` |
||||
|
||||
.. py:class:: magnum.trade.ImporterManager |
||||
:summary: Manager for `AbstractImporter` plugin instances |
||||
|
||||
Each plugin returned by `instantiate()` or `load_and_instantiate()` |
||||
references its owning `ImporterManager` through `AbstractImporter.manager`, |
||||
ensuring the manager is not deleted before the plugin instances are. |
||||
|
||||
.. py:class:: magnum.trade.AbstractImporter |
||||
|
||||
Similarly to C++, importer plugins are loaded through `ImporterManager`: |
||||
|
||||
.. |
||||
>>> from magnum import trade |
||||
|
||||
.. code:: py |
||||
|
||||
>>> manager = trade.ImporterManager() |
||||
>>> importer = manager.load_and_instantiate('PngImporter') |
||||
|
||||
Unlike C++, errors in both API usage and file parsing are reported by |
||||
raising an exception. See particular function documentation for detailed |
||||
behavior. |
||||
|
||||
.. py:function:: magnum.trade.AbstractImporter.open_data |
||||
:raise RuntimeError: If file opening fails |
||||
|
||||
.. py:function:: magnum.trade.AbstractImporter.open_file |
||||
:raise RuntimeError: If file opening fails |
||||
|
||||
.. py:property:: magnum.trade.AbstractImporter.image1d_count |
||||
:raise RuntimeError: If no file is opened |
||||
.. py:property:: magnum.trade.AbstractImporter.image2d_count |
||||
:raise RuntimeError: If no file is opened |
||||
.. py:property:: magnum.trade.AbstractImporter.image3d_count |
||||
:raise RuntimeError: If no file is opened |
||||
|
||||
.. py:function:: magnum.trade.AbstractImporter.image1d_for_name |
||||
:raise RuntimeError: If no file is opened |
||||
.. py:function:: magnum.trade.AbstractImporter.image2d_for_name |
||||
:raise RuntimeError: If no file is opened |
||||
.. py:function:: magnum.trade.AbstractImporter.image3d_for_name |
||||
:raise RuntimeError: If no file is opened |
||||
|
||||
.. py:function:: magnum.trade.AbstractImporter.image1d_name |
||||
:raise RuntimeError: If no file is opened |
||||
:raise ValueError: If :p:`id` is negative or not less than `image1d_count` |
||||
.. py:function:: magnum.trade.AbstractImporter.image2d_name |
||||
:raise RuntimeError: If no file is opened |
||||
:raise ValueError: If :p:`id` is negative or not less than `image2d_count` |
||||
.. py:function:: magnum.trade.AbstractImporter.image3d_name |
||||
:raise RuntimeError: If no file is opened |
||||
:raise ValueError: If :p:`id` is negative or not less than `image3d_count` |
||||
|
||||
.. py:function:: magnum.trade.AbstractImporter.image1d |
||||
:raise RuntimeError: If no file is opened |
||||
:raise ValueError: If :p:`id` is negative or not less than `image1d_count` |
||||
.. py:function:: magnum.trade.AbstractImporter.image2d |
||||
:raise RuntimeError: If no file is opened |
||||
:raise ValueError: If :p:`id` is negative or not less than `image2d_count` |
||||
.. py:function:: magnum.trade.AbstractImporter.image3d |
||||
:raise RuntimeError: If no file is opened |
||||
:raise ValueError: If :p:`id` is negative or not less than `image3d_count` |
||||
@ -0,0 +1,109 @@
|
||||
#ifndef corrade_pluginmanager_h |
||||
#define corrade_pluginmanager_h |
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 |
||||
Vladimír Vondruš <mosra@centrum.cz> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a |
||||
copy of this software and associated documentation files (the "Software"), |
||||
to deal in the Software without restriction, including without limitation |
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||
and/or sell copies of the Software, and to permit persons to whom the |
||||
Software is furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included |
||||
in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||
DEALINGS IN THE SOFTWARE. |
||||
*/ |
||||
|
||||
#include <memory> /* :( */ |
||||
#include <pybind11/pybind11.h> |
||||
#include <Corrade/PluginManager/Manager.h> |
||||
|
||||
#include "Corrade/Python.h" |
||||
|
||||
#include "corrade/bootstrap.h" |
||||
|
||||
namespace Corrade { namespace PluginManager { |
||||
|
||||
/* Stores additional stuff needed for proper refcounting of array views. Due
|
||||
to obvious reasons we can't subclass plugins so this is the only possible |
||||
way. */ |
||||
template<class T> struct PyPluginHolder: std::unique_ptr<T> { |
||||
explicit PyPluginHolder(T*) { |
||||
/* Pybind needs this signature, but it should never be called */ |
||||
CORRADE_ASSERT_UNREACHABLE(); |
||||
} |
||||
|
||||
explicit PyPluginHolder(T* object, pybind11::object manager) noexcept: std::unique_ptr<T>{object}, manager{std::move(manager)} {} |
||||
|
||||
PyPluginHolder(PyPluginHolder<T>&&) noexcept = default; |
||||
PyPluginHolder(const PyPluginHolder<T>&) = delete; |
||||
PyPluginHolder<T>& operator=(PyPluginHolder<T>&&) noexcept = default; |
||||
PyPluginHolder<T>& operator=(const PyPluginHolder<T>&) = default; |
||||
|
||||
~PyPluginHolder() { |
||||
/* On destruction, first `manager` and then the plugin would be
|
||||
destroyed, which would mean it asserts due to the manager being |
||||
destructed while plugins are still around. To flip the order, we |
||||
need to reset the pointer first */ |
||||
std::unique_ptr<T>::reset(); |
||||
} |
||||
|
||||
pybind11::object manager; |
||||
}; |
||||
|
||||
}} |
||||
|
||||
PYBIND11_DECLARE_HOLDER_TYPE(T, Corrade::PluginManager::PyPluginHolder<T>) |
||||
|
||||
namespace corrade { |
||||
|
||||
template<class T> void plugin(py::class_<T, PluginManager::PyPluginHolder<T>>& c) { |
||||
c |
||||
.def_property_readonly("manager", [](const T& self) { |
||||
return pyObjectHolderFor<PluginManager::PyPluginHolder>(self).manager; |
||||
}, "Manager owning this plugin instance"); |
||||
} |
||||
|
||||
template<class T> void manager(py::class_<PluginManager::Manager<T>, PluginManager::AbstractManager>& c) { |
||||
c |
||||
.def(py::init<const std::string&>(), py::arg("plugin_directory") = std::string{}, "Constructor") |
||||
.def("instantiate", [](PluginManager::Manager<T>& self, const std::string& plugin) { |
||||
/* This causes a double lookup, but well... better than dying */ |
||||
if(!(self.loadState(plugin) & PluginManager::LoadState::Loaded)) { |
||||
PyErr_Format(PyExc_RuntimeError, "plugin %s is not loaded", plugin.data()); |
||||
throw py::error_already_set{}; |
||||
} |
||||
|
||||
auto loaded = self.instantiate(plugin); |
||||
if(!loaded) { |
||||
PyErr_Format(PyExc_RuntimeError, "can't instantiate plugin %s", plugin.data()); |
||||
throw py::error_already_set{}; |
||||
} |
||||
|
||||
return PluginManager::PyPluginHolder<T>{loaded.release(), py::cast(self)}; |
||||
}) |
||||
.def("load_and_instantiate", [](PluginManager::Manager<T>& self, const std::string& plugin) { |
||||
auto loaded = self.loadAndInstantiate(plugin); |
||||
if(!loaded) { |
||||
PyErr_Format(PyExc_RuntimeError, "can't load and instantiate plugin %s", plugin.data()); |
||||
throw py::error_already_set{}; |
||||
} |
||||
|
||||
return PluginManager::PyPluginHolder<T>{loaded.release(), py::cast(self)}; |
||||
}); |
||||
} |
||||
|
||||
} |
||||
|
||||
#endif |
||||
|
After Width: | Height: | Size: 81 B |
Binary file not shown.
Loading…
Reference in new issue