mirror of https://github.com/mosra/magnum.git
Browse Source
It'll get used outside of the root namespace and since the callbacks tend to be quite complex, it would be silly to require users to implement one callback for Trade, one for Text and one for Audio, for example.audio-import
Vladimír Vondruš
7 years ago
13 changed files with 265 additions and 126 deletions
@ -0,0 +1,46 @@ |
|||||||
|
/*
|
||||||
|
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 "FileCallback.h" |
||||||
|
|
||||||
|
#include <Corrade/Utility/Debug.h> |
||||||
|
|
||||||
|
namespace Magnum { |
||||||
|
|
||||||
|
Debug& operator<<(Debug& debug, const InputFileCallbackPolicy value) { |
||||||
|
switch(value) { |
||||||
|
/* LCOV_EXCL_START */ |
||||||
|
#define _c(v) case InputFileCallbackPolicy::v: return debug << "InputFileCallbackPolicy::" #v; |
||||||
|
_c(LoadTemporary) |
||||||
|
_c(LoadPernament) |
||||||
|
_c(Close) |
||||||
|
#undef _c |
||||||
|
/* LCOV_EXCL_STOP */ |
||||||
|
} |
||||||
|
|
||||||
|
return debug << "InputFileCallbackPolicy(" << Debug::nospace << reinterpret_cast<void*>(UnsignedByte(value)) << Debug::nospace << ")"; |
||||||
|
} |
||||||
|
|
||||||
|
} |
||||||
@ -0,0 +1,92 @@ |
|||||||
|
#ifndef Magnum_FileCallback_h |
||||||
|
#define Magnum_FileCallback_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. |
||||||
|
*/ |
||||||
|
|
||||||
|
/** @file
|
||||||
|
* @brief Enum @ref Magnum::InputFileCallbackPolicy |
||||||
|
*/ |
||||||
|
|
||||||
|
#include "Magnum/Magnum.h" |
||||||
|
#include "Magnum/visibility.h" |
||||||
|
|
||||||
|
namespace Magnum { |
||||||
|
|
||||||
|
/**
|
||||||
|
@brief Input file callback policy |
||||||
|
|
||||||
|
@see @ref Trade::AbstractImporter::setFileCallback(), |
||||||
|
@ref Trade-AbstractImporter-usage-callbacks |
||||||
|
*/ |
||||||
|
enum class InputFileCallbackPolicy: UnsignedByte { |
||||||
|
/**
|
||||||
|
* The requested file is used only during a call of given function and the |
||||||
|
* memory view is not referenced anymore once the function exits. |
||||||
|
* |
||||||
|
* This can be the case for example when importing image data using |
||||||
|
* @ref Trade::AbstractImporter::image2D() --- imported data are copied |
||||||
|
* into the returned @ref Trade::ImageData2D object and the original file |
||||||
|
* is not needed anymore. Note, however, that this might not be the case |
||||||
|
* for all importers --- see documentation of a particular plugin for |
||||||
|
* concrete info. |
||||||
|
*/ |
||||||
|
LoadTemporary, |
||||||
|
|
||||||
|
/**
|
||||||
|
* The requested file may be used for loading most or all data in the next |
||||||
|
* steps, so the importer expects the memory view to be valid for as long |
||||||
|
* as data import functions are called on it, but at most until the |
||||||
|
* data importer is destroyed, its @ref Trade::AbstractImporter::close() "close()" |
||||||
|
* function is called or another file is opened. |
||||||
|
* |
||||||
|
* This can be the case for example when importing mesh data using |
||||||
|
* @ref Trade::AbstractImporter::mesh3D() --- all vertex data might be |
||||||
|
* combined in a single binary file and each mesh occupies only a portion |
||||||
|
* of it. Note, however, that this might not be the case for all importers |
||||||
|
* --- see documentation of a particular plugin for concrete info. |
||||||
|
*/ |
||||||
|
LoadPernament, |
||||||
|
|
||||||
|
/**
|
||||||
|
* A file that has been previously loaded by this callback can be closed |
||||||
|
* now (and its memory freed). This is just a hint, it's not *required* for |
||||||
|
* the callback to close it. This policy is also only ever called with a |
||||||
|
* file that was previously opened with the same callback, so it's possible |
||||||
|
* to completely ignore it and just return the cached value. |
||||||
|
* |
||||||
|
* This can be the case for example when an importer is done parsing a text |
||||||
|
* file into an internal representation and the original data are no longer |
||||||
|
* needed (and, for example, other files need to be loaded and they could |
||||||
|
* repurpose the unused memory). |
||||||
|
*/ |
||||||
|
Close |
||||||
|
}; |
||||||
|
|
||||||
|
/** @debugoperatorenum{InputFileCallbackPolicy} */ |
||||||
|
MAGNUM_EXPORT Debug& operator<<(Debug& debug, InputFileCallbackPolicy value); |
||||||
|
|
||||||
|
} |
||||||
|
|
||||||
|
#endif |
||||||
@ -0,0 +1,52 @@ |
|||||||
|
/*
|
||||||
|
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 <sstream> |
||||||
|
#include <Corrade/TestSuite/Tester.h> |
||||||
|
|
||||||
|
#include "Magnum/FileCallback.h" |
||||||
|
|
||||||
|
namespace Magnum { namespace Test { namespace { |
||||||
|
|
||||||
|
struct FileCallbackTest: TestSuite::Tester { |
||||||
|
explicit FileCallbackTest(); |
||||||
|
|
||||||
|
void debugInputFileCallbackPolicy(); |
||||||
|
}; |
||||||
|
|
||||||
|
FileCallbackTest::FileCallbackTest() { |
||||||
|
addTests({&FileCallbackTest::debugInputFileCallbackPolicy}); |
||||||
|
} |
||||||
|
|
||||||
|
void FileCallbackTest::debugInputFileCallbackPolicy() { |
||||||
|
std::ostringstream out; |
||||||
|
|
||||||
|
Debug{&out} << InputFileCallbackPolicy::Close << InputFileCallbackPolicy(0xf0); |
||||||
|
CORRADE_COMPARE(out.str(), "InputFileCallbackPolicy::Close InputFileCallbackPolicy(0xf0)\n"); |
||||||
|
} |
||||||
|
|
||||||
|
}}} |
||||||
|
|
||||||
|
CORRADE_TEST_MAIN(Magnum::Test::FileCallbackTest) |
||||||
Loading…
Reference in new issue