Options.h

#pragma once
 
/* <editor-fold desc="MIT License">
 
Copyright(c) 2018 Robert Osfield
 
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.
 
</editor-fold> */
 
#include <vsg/core/Inherit.h>
#include <vsg/core/observer_ptr.h>
#include <vsg/io/FileSystem.h>
#include <vsg/maths/transform.h>
#include <vsg/state/StateCommand.h>
 
namespace vsg
{
 
    class SharedObjects;
    class ReaderWriter;
    class OperationThreads;
    class CommandLine;
    class ShaderSet;
 
    using ReaderWriters = std::vector<ref_ptr<ReaderWriter>>;
 
    class VSG_DECLSPEC Options : public Inherit<Object, Options>
    {
    public:
        Options();
        explicit Options(const Options& options);
 
        template<typename... Args>
        explicit Options(Args... args)
        {
            (add(args), ...);
        }
 
        Options& operator=(const Options& rhs) = delete;
 
        int compare(const Object& rhs) const override;
 
        virtual bool readOptions(CommandLine& arguments);
 
        void read(Input& input) override;
        void write(Output& output) const override;
 
        void add(ref_ptr<ReaderWriter> rw = {});
        void add(const ReaderWriters& rws);
 
        ref_ptr<SharedObjects> sharedObjects;
        ReaderWriters readerWriters;
        ref_ptr<OperationThreads> operationThreads;
 
        enum FindFileHint
        {
            CHECK_ORIGINAL_FILENAME_EXISTS_FIRST, 
            CHECK_ORIGINAL_FILENAME_EXISTS_LAST,  
            ONLY_CHECK_PATHS                      
        };
        FindFileHint checkFilenameHint = CHECK_ORIGINAL_FILENAME_EXISTS_FIRST;
 
        Paths paths;
 
        using FindFileCallback = std::function<Path(const Path& filename, const Options* options)>;
        FindFileCallback findFileCallback;
 
        Path fileCache;
 
        Path extensionHint;
        bool mapRGBtoRGBAHint = true;
 
        CoordinateConvention sceneCoordinateConvention = CoordinateConvention::Z_UP;
 
        std::map<Path, CoordinateConvention> formatCoordinateConventions;
 
        std::map<std::string, ref_ptr<ShaderSet>> shaderSets;
 
        StateCommands inheritedState;
 
    protected:
        virtual ~Options();
    };
    VSG_type_name(vsg::Options);
 
    extern VSG_DECLSPEC ref_ptr<const vsg::Options> prependPathToOptionsIfRequired(const vsg::Path& filename, ref_ptr<const vsg::Options> options);
 
    template<typename... Args>
    bool compatibleExtension(const vsg::Path& filename, const vsg::Options* options, const Args&... args)
    {
        if (options && options->extensionHint && contains(options->extensionHint, args...)) return true;
        return contains(vsg::lowerCaseFileExtension(filename), args...);
    }
 
    template<typename... Args>
    bool compatibleExtension(const vsg::Options* options, const Args&... args)
    {
        return options && options->extensionHint && contains(options->extensionHint, args...);
    }
 
} // namespace vsg