From d523ab71249725e60c48543fbda9c9a44e42b6df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 8 Apr 2021 12:09:25 +0200 Subject: [PATCH] ShaderTools: less confusing function parameter names. --- src/Magnum/ShaderTools/AbstractConverter.cpp | 90 +++++++++---------- src/Magnum/ShaderTools/AbstractConverter.h | 20 ++--- .../AnyShaderConverter/AnyConverter.cpp | 6 +- .../AnyShaderConverter/AnyConverter.h | 2 +- 4 files changed, 59 insertions(+), 59 deletions(-) diff --git a/src/Magnum/ShaderTools/AbstractConverter.cpp b/src/Magnum/ShaderTools/AbstractConverter.cpp index e43a4ee79..98c35db2a 100644 --- a/src/Magnum/ShaderTools/AbstractConverter.cpp +++ b/src/Magnum/ShaderTools/AbstractConverter.cpp @@ -268,7 +268,7 @@ Containers::Array AbstractConverter::doConvertDataToData(Stage, Containers CORRADE_ASSERT_UNREACHABLE("ShaderTools::AbstractConverter::convertDataToData(): feature advertised but not implemented", {}); } -bool AbstractConverter::convertDataToFile(const Stage stage, const Containers::ArrayView data, const Containers::StringView to) { +bool AbstractConverter::convertDataToFile(const Stage stage, const Containers::ArrayView data, const Containers::StringView filename) { CORRADE_ASSERT(features() >= ConverterFeature::ConvertData, "ShaderTools::AbstractConverter::convertDataToFile(): feature not supported", {}); @@ -278,22 +278,22 @@ bool AbstractConverter::convertDataToFile(const Stage stage, const Containers::A Containers::Array out = doConvertDataToData(stage, Containers::arrayCast(data)); if(!out) return false; - if(!Utility::Directory::write(to, out)) { - Error{} << "ShaderTools::AbstractConverter::convertDataToFile(): cannot write to file" << to; + if(!Utility::Directory::write(filename, out)) { + Error{} << "ShaderTools::AbstractConverter::convertDataToFile(): cannot write to file" << filename; return false; } return true; } -Containers::Array AbstractConverter::convertDataToDataUsingInputFileCallbacks(const char* const prefix, const Stage stage, const Containers::StringView from) { - const Containers::Optional> data = _inputFileCallback(from, InputFileCallbackPolicy::LoadTemporary, _inputFileCallbackUserData); +Containers::Array AbstractConverter::convertDataToDataUsingInputFileCallbacks(const char* const prefix, const Stage stage, const Containers::StringView filename) { + const Containers::Optional> data = _inputFileCallback(filename, InputFileCallbackPolicy::LoadTemporary, _inputFileCallbackUserData); if(!data) { - Error{} << prefix << "cannot open file" << from; + Error{} << prefix << "cannot open file" << filename; return {}; } Containers::Array out = doConvertDataToData(stage, *data); - _inputFileCallback(from, InputFileCallbackPolicy::Close, _inputFileCallbackUserData); + _inputFileCallback(filename, InputFileCallbackPolicy::Close, _inputFileCallbackUserData); return out; } @@ -367,7 +367,7 @@ bool AbstractConverter::doConvertFileToFile(const Stage stage, const Containers: return true; } -Containers::Array AbstractConverter::convertFileToData(const Stage stage, const Containers::StringView from) { +Containers::Array AbstractConverter::convertFileToData(const Stage stage, const Containers::StringView filename) { CORRADE_ASSERT(features() >= ConverterFeature::ConvertData, "ShaderTools::AbstractConverter::convertFileToData(): feature not supported", {}); @@ -376,7 +376,7 @@ Containers::Array AbstractConverter::convertFileToData(const Stage stage, /* If input file callbacks are not set or the converter supports handling them directly, call into the implementation */ if(!_inputFileCallback || (doFeatures() & ConverterFeature::InputFileCallback)) { - out = doConvertFileToData(stage, from); + out = doConvertFileToData(stage, filename); /* Otherwise use the callback and pass the data through to convertDataToData(). Mark the file as ready to be closed once conversion @@ -392,7 +392,7 @@ Containers::Array AbstractConverter::convertFileToData(const Stage stage, actual file loading to the default implementation (callback used in the base doConvertFileToData() implementation, because this branch is never taken in that case) */ - out = convertDataToDataUsingInputFileCallbacks("ShaderTools::AbstractConverter::convertFileToData():", stage, from); + out = convertDataToDataUsingInputFileCallbacks("ShaderTools::AbstractConverter::convertFileToData():", stage, filename); } CORRADE_ASSERT(!out.deleter(), @@ -400,20 +400,20 @@ Containers::Array AbstractConverter::convertFileToData(const Stage stage, return out; } -Containers::Array AbstractConverter::doConvertFileToData(const Stage stage, const Containers::StringView from) { +Containers::Array AbstractConverter::doConvertFileToData(const Stage stage, const Containers::StringView filename) { /* If callbacks are set, use them. This is the same implementation as in convertFileToFile(), see the comment there for details. */ if(_inputFileCallback) { - return convertDataToDataUsingInputFileCallbacks("ShaderTools::AbstractConverter::convertFileToData():", stage, from); + return convertDataToDataUsingInputFileCallbacks("ShaderTools::AbstractConverter::convertFileToData():", stage, filename); /* Otherwise open the file directly */ } else { - if(!Utility::Directory::exists(from)) { - Error() << "ShaderTools::AbstractConverter::convertFileToData(): cannot open file" << from; + if(!Utility::Directory::exists(filename)) { + Error() << "ShaderTools::AbstractConverter::convertFileToData(): cannot open file" << filename; return {}; } - return doConvertDataToData(stage, Utility::Directory::read(from)); + return doConvertDataToData(stage, Utility::Directory::read(filename)); } } @@ -440,7 +440,7 @@ Containers::Array AbstractConverter::doLinkDataToData(Containers::ArrayVie CORRADE_ASSERT_UNREACHABLE("ShaderTools::AbstractConverter::linkDataToData(): feature advertised but not implemented", {}); } -bool AbstractConverter::linkDataToFile(const Containers::ArrayView>> data, const Containers::StringView to) { +bool AbstractConverter::linkDataToFile(const Containers::ArrayView>> data, const Containers::StringView filename) { CORRADE_ASSERT(features() >= ConverterFeature::LinkData, "ShaderTools::AbstractConverter::linkDataToFile(): feature not supported", {}); CORRADE_ASSERT(!(_flags & ConverterFlag::PreprocessOnly), @@ -454,45 +454,45 @@ bool AbstractConverter::linkDataToFile(const Containers::ArrayView out = doLinkDataToData(Containers::arrayCast>>(data)); if(!out) return false; - if(!Utility::Directory::write(to, out)) { - Error{} << "ShaderTools::AbstractConverter::linkDataToFile(): cannot write to file" << to; + if(!Utility::Directory::write(filename, out)) { + Error{} << "ShaderTools::AbstractConverter::linkDataToFile(): cannot write to file" << filename; return false; } return true; } -bool AbstractConverter::linkDataToFile(const std::initializer_list>> data, const Containers::StringView to) { - return linkDataToFile(Containers::arrayView(data), to); +bool AbstractConverter::linkDataToFile(const std::initializer_list>> data, const Containers::StringView filename) { + return linkDataToFile(Containers::arrayView(data), filename); } -Containers::Array AbstractConverter::linkDataToDataUsingInputFileCallbacks(const char* const prefix, const Containers::ArrayView> from) { - Containers::Array>> data{Containers::NoInit, from.size()}; +Containers::Array AbstractConverter::linkDataToDataUsingInputFileCallbacks(const char* const prefix, const Containers::ArrayView> filenames) { + Containers::Array>> data{Containers::NoInit, filenames.size()}; /* First load all files. Remember how many of these succeeded so we can close them again after */ std::size_t i; - for(i = 0; i != from.size(); ++i) { - const Containers::Optional> contents = _inputFileCallback(from[i].second, InputFileCallbackPolicy::LoadTemporary, _inputFileCallbackUserData); + for(i = 0; i != filenames.size(); ++i) { + const Containers::Optional> contents = _inputFileCallback(filenames[i].second, InputFileCallbackPolicy::LoadTemporary, _inputFileCallbackUserData); if(!contents) break; - data[i].first = from[i].first; + data[i].first = filenames[i].first; data[i].second = *contents; } /* If all input files loaded successfully, process */ Containers::Array out; - if(i == from.size()) out = doLinkDataToData(data); + if(i == filenames.size()) out = doLinkDataToData(data); /* Close again all input files that loaded successfully */ for(std::size_t ii = 0; ii != i; ++ii) - _inputFileCallback(from[ii].second, InputFileCallbackPolicy::Close, _inputFileCallbackUserData); + _inputFileCallback(filenames[ii].second, InputFileCallbackPolicy::Close, _inputFileCallbackUserData); /* Now that we have cleaned up correctly, it's time print the error message if something didn't go well. IN this case doLinkDataToData() was not called at all. */ - if(i != from.size()) { - Error{} << prefix << "cannot open file" << from[i].second; + if(i != filenames.size()) { + Error{} << prefix << "cannot open file" << filenames[i].second; return {}; } @@ -591,12 +591,12 @@ bool AbstractConverter::doLinkFilesToFile(const Containers::ArrayView AbstractConverter::linkFilesToData(const Containers::ArrayView> from) { +Containers::Array AbstractConverter::linkFilesToData(const Containers::ArrayView> filenames) { CORRADE_ASSERT(features() >= ConverterFeature::LinkData, "ShaderTools::AbstractConverter::linkFilesToData(): feature not supported", {}); CORRADE_ASSERT(!(_flags & ConverterFlag::PreprocessOnly), "ShaderTools::AbstractConverter::linkFilesToData(): PreprocessOnly is not allowed in combination with linking", {}); - CORRADE_ASSERT(!from.empty(), + CORRADE_ASSERT(!filenames.empty(), "ShaderTools::AbstractConverter::linkFilesToData(): no files passed", {}); Containers::Array out; @@ -604,7 +604,7 @@ Containers::Array AbstractConverter::linkFilesToData(const Containers::Arr /* If input file callbacks are not set or the converter supports handling them directly, call into the implementation */ if(!_inputFileCallback || (doFeatures() & ConverterFeature::InputFileCallback)) { - out = doLinkFilesToData(from); + out = doLinkFilesToData(filenames); /* Otherwise use the callback and pass the data through to convertDataToData(). Mark the file as ready to be closed once conversion @@ -620,7 +620,7 @@ Containers::Array AbstractConverter::linkFilesToData(const Containers::Arr actual file loading to the default implementation (callback used in the base doLinkFilesToData() implementation, because this branch is never taken in that case) */ - out = linkDataToDataUsingInputFileCallbacks("ShaderTools::AbstractConverter::linkFilesToData():", from); + out = linkDataToDataUsingInputFileCallbacks("ShaderTools::AbstractConverter::linkFilesToData():", filenames); } CORRADE_ASSERT(!out.deleter(), @@ -628,32 +628,32 @@ Containers::Array AbstractConverter::linkFilesToData(const Containers::Arr return out; } -Containers::Array AbstractConverter::linkFilesToData(const std::initializer_list> from) { - return linkFilesToData(Containers::arrayView(from)); +Containers::Array AbstractConverter::linkFilesToData(const std::initializer_list> filenames) { + return linkFilesToData(Containers::arrayView(filenames)); } -Containers::Array AbstractConverter::doLinkFilesToData(const Containers::ArrayView> from) { +Containers::Array AbstractConverter::doLinkFilesToData(const Containers::ArrayView> filenames) { /* If callbacks are set, use them. This is the same implementation as in linkFilesToFile(), see the comment there for details. */ if(_inputFileCallback) { - return linkDataToDataUsingInputFileCallbacks("ShaderTools::AbstractConverter::linkFilesToData():", from); + return linkDataToDataUsingInputFileCallbacks("ShaderTools::AbstractConverter::linkFilesToData():", filenames); /* Otherwise open the files directly */ } else { - Containers::Array> fileData{from.size()}; - for(std::size_t i = 0; i != from.size(); ++i) { - if(!Utility::Directory::exists(from[i].second)) { - Error() << "ShaderTools::AbstractConverter::linkFilesToData(): cannot open file" << from[i].second; + Containers::Array> fileData{filenames.size()}; + for(std::size_t i = 0; i != filenames.size(); ++i) { + if(!Utility::Directory::exists(filenames[i].second)) { + Error() << "ShaderTools::AbstractConverter::linkFilesToData(): cannot open file" << filenames[i].second; return {}; } - fileData[i] = Utility::Directory::read(from[i].second); + fileData[i] = Utility::Directory::read(filenames[i].second); } /** @todo merge the allocations once we have an ArrayTuple */ - Containers::Array>> data{Containers::NoInit, from.size()}; - for(std::size_t i = 0; i != from.size(); ++i) { - data[i].first = from[i].first; + Containers::Array>> data{Containers::NoInit, filenames.size()}; + for(std::size_t i = 0; i != filenames.size(); ++i) { + data[i].first = filenames[i].first; data[i].second = fileData[i]; } diff --git a/src/Magnum/ShaderTools/AbstractConverter.h b/src/Magnum/ShaderTools/AbstractConverter.h index 61ff94112..ab3cc965c 100644 --- a/src/Magnum/ShaderTools/AbstractConverter.h +++ b/src/Magnum/ShaderTools/AbstractConverter.h @@ -765,7 +765,7 @@ class MAGNUM_SHADERTOOLS_EXPORT AbstractConverter: public PluginManager::Abstrac * @see @ref features(), @ref convertDataToData(), * @ref convertFileToData(), @ref convertFileToFile() */ - bool convertDataToFile(Stage stage, Containers::ArrayView data, Containers::StringView to); + bool convertDataToFile(Stage stage, Containers::ArrayView data, Containers::StringView filename); /** * @brief Convert shader file to a file @@ -792,7 +792,7 @@ class MAGNUM_SHADERTOOLS_EXPORT AbstractConverter: public PluginManager::Abstrac * @see @ref features(), @ref convertFileToFile(), * @ref convertDataToFile(), @ref convertDataToData() */ - Containers::Array convertFileToData(Stage stage, const Containers::StringView from); + Containers::Array convertFileToData(Stage stage, Containers::StringView filename); /** * @brief Link shader data together to a data @@ -820,10 +820,10 @@ class MAGNUM_SHADERTOOLS_EXPORT AbstractConverter: public PluginManager::Abstrac * @see @ref features(), @ref linkFilesToFile(), * @ref linkFilesToData(), @ref linkDataToData() */ - bool linkDataToFile(Containers::ArrayView>> data, Containers::StringView to); + bool linkDataToFile(Containers::ArrayView>> data, Containers::StringView filename); /** @overload */ - bool linkDataToFile(std::initializer_list>> data, Containers::StringView to); + bool linkDataToFile(std::initializer_list>> data, Containers::StringView filename); /** * @brief Link shader files together to a file @@ -856,10 +856,10 @@ class MAGNUM_SHADERTOOLS_EXPORT AbstractConverter: public PluginManager::Abstrac * @see @ref features(), @ref linkFilesToFile(), @ref linkDataToFile(), * @ref linkDataToData() */ - Containers::Array linkFilesToData(Containers::ArrayView> from); + Containers::Array linkFilesToData(Containers::ArrayView> filenames); /** @overload */ - Containers::Array linkFilesToData(std::initializer_list> from); + Containers::Array linkFilesToData(std::initializer_list> filenames); protected: /** @@ -911,7 +911,7 @@ class MAGNUM_SHADERTOOLS_EXPORT AbstractConverter: public PluginManager::Abstrac * is not supported --- instead, file is loaded though the callback and * data passed through to @ref doConvertDataToData(). */ - virtual Containers::Array doConvertFileToData(Stage stage, Containers::StringView from); + virtual Containers::Array doConvertFileToData(Stage stage, Containers::StringView filename); /** * @brief Implementation for @ref linkFilesToFile() @@ -945,7 +945,7 @@ class MAGNUM_SHADERTOOLS_EXPORT AbstractConverter: public PluginManager::Abstrac * is not supported --- instead, file is loaded though the callback and * data passed through to @ref doConvertDataToData(). */ - virtual Containers::Array doLinkFilesToData(Containers::ArrayView> from); + virtual Containers::Array doLinkFilesToData(Containers::ArrayView> filenames); private: /** @@ -1056,7 +1056,7 @@ class MAGNUM_SHADERTOOLS_EXPORT AbstractConverter: public PluginManager::Abstrac /* Used by convertFileToFile(), doConvertFileToFile(), convertFileToData() and doConvertFileToData() */ - MAGNUM_SHADERTOOLS_LOCAL Containers::Array convertDataToDataUsingInputFileCallbacks(const char* prefix, const Stage stage, Containers::StringView from); + MAGNUM_SHADERTOOLS_LOCAL Containers::Array convertDataToDataUsingInputFileCallbacks(const char* prefix, const Stage stage, Containers::StringView filename); /** * @brief Implementation for @ref convertDataToData() @@ -1070,7 +1070,7 @@ class MAGNUM_SHADERTOOLS_EXPORT AbstractConverter: public PluginManager::Abstrac /* Used by linkFilesToFile(), doLinkFilesToFile(), linkFilesToData() and doLinkFilesToData() */ - MAGNUM_SHADERTOOLS_LOCAL Containers::Array linkDataToDataUsingInputFileCallbacks(const char* prefix, Containers::ArrayView> from); + MAGNUM_SHADERTOOLS_LOCAL Containers::Array linkDataToDataUsingInputFileCallbacks(const char* prefix, Containers::ArrayView> filenames); /** * @brief Implementation for @ref linkDataToData() diff --git a/src/MagnumPlugins/AnyShaderConverter/AnyConverter.cpp b/src/MagnumPlugins/AnyShaderConverter/AnyConverter.cpp index ca7788d6e..26e98ac27 100644 --- a/src/MagnumPlugins/AnyShaderConverter/AnyConverter.cpp +++ b/src/MagnumPlugins/AnyShaderConverter/AnyConverter.cpp @@ -361,13 +361,13 @@ bool AnyConverter::doConvertFileToFile(const Stage stage, const Containers::Stri return converter->convertFileToFile(stage, from, to); } -Containers::Array AnyConverter::doConvertFileToData(const Stage stage, const Containers::StringView from) { +Containers::Array AnyConverter::doConvertFileToData(const Stage stage, const Containers::StringView filename) { CORRADE_INTERNAL_ASSERT(manager()); /* Prefer the explicitly set input format. If not set, fall back to detecting based on input and output extension. */ const Containers::StringView formatFrom = stringForFormat( - _state->inputFormat != Format::Unspecified ? _state->inputFormat : formatForExtension("ShaderTools::AnyConverter::convertFileToData():", from) + _state->inputFormat != Format::Unspecified ? _state->inputFormat : formatForExtension("ShaderTools::AnyConverter::convertFileToData():", filename) ); if(formatFrom.isEmpty()) return {}; if(_state->outputFormat == Format::Unspecified) { @@ -439,7 +439,7 @@ Containers::Array AnyConverter::doConvertFileToData(const Stage stage, con /* Try to convert the file (error output should be printed by the plugin itself) */ - return converter->convertFileToData(stage, from); + return converter->convertFileToData(stage, filename); } Containers::Array AnyConverter::doConvertDataToData(const Stage stage, const Containers::ArrayView from) { diff --git a/src/MagnumPlugins/AnyShaderConverter/AnyConverter.h b/src/MagnumPlugins/AnyShaderConverter/AnyConverter.h index 859f20445..f1529dd53 100644 --- a/src/MagnumPlugins/AnyShaderConverter/AnyConverter.h +++ b/src/MagnumPlugins/AnyShaderConverter/AnyConverter.h @@ -144,7 +144,7 @@ class MAGNUM_ANYSHADERCONVERTER_EXPORT AnyConverter: public AbstractConverter { MAGNUM_ANYSHADERCONVERTER_LOCAL std::pair doValidateFile(Stage stage, Containers::StringView filename) override; MAGNUM_ANYSHADERCONVERTER_LOCAL std::pair doValidateData(Stage stage, Containers::ArrayView data) override; MAGNUM_ANYSHADERCONVERTER_LOCAL bool doConvertFileToFile(Stage stage, Containers::StringView from, Containers::StringView to) override; - MAGNUM_ANYSHADERCONVERTER_LOCAL Containers::Array doConvertFileToData(Magnum::ShaderTools::Stage stage, Containers::StringView from) override; + MAGNUM_ANYSHADERCONVERTER_LOCAL Containers::Array doConvertFileToData(Magnum::ShaderTools::Stage stage, Containers::StringView filename) override; MAGNUM_ANYSHADERCONVERTER_LOCAL Containers::Array doConvertDataToData(Magnum::ShaderTools::Stage stage, Containers::ArrayView data) override; struct State;