/*

-----------------------------------------------------------------------------

This source file is part of OGRE

(Object-oriented Graphics Rendering Engine)

For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2014 Torus Knot Software Ltd

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 "OgreStableHeaders.h"

#include "OgreUnifiedHighLevelGpuProgram.h"

#include "OgreGpuProgramManager.h"

namespace Ogre

{

    //-----------------------------------------------------------------------

    /// Command object for setting delegate (can set more than once)

    class CmdDelegate : public ParamCommand

    {

    public:

        String doGet(const void* target) const override;

        void doSet(void* target, const String& val) override;

    };

    static CmdDelegate msCmdDelegate;

    static const String sLanguage = "unified";

    //-----------------------------------------------------------------------

    //-----------------------------------------------------------------------

    UnifiedHighLevelGpuProgram::UnifiedHighLevelGpuProgram(

        ResourceManager* creator, const String& name, ResourceHandle handle,

        const String& group, bool isManual, ManualResourceLoader* loader)

        :GpuProgram(creator, name, handle, group, isManual, loader)

    {

        if (createParamDictionary("UnifiedHighLevelGpuProgram"))

        {

            setupBaseParamDictionary();

            ParamDictionary* dict = getParamDictionary();

            dict->addParameter(ParameterDef("delegate",

                "Additional delegate programs containing implementations.",

                PT_STRING),&msCmdDelegate);

        }

    }

    //-----------------------------------------------------------------------

    UnifiedHighLevelGpuProgram::~UnifiedHighLevelGpuProgram()

    {

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::chooseDelegate() const

    {

        OGRE_LOCK_AUTO_MUTEX;

        mChosenDelegate.reset();

        for (const String& dn : mDelegateNames)

        {

            GpuProgramPtr deleg = GpuProgramManager::getSingleton().getByName(dn, mGroup);

            //recheck with auto resource group

            if (!deleg)

                deleg = GpuProgramManager::getSingleton().getByName(dn, RGN_AUTODETECT);

            // Silently ignore missing links

            if(!deleg || (!deleg->isSupported() && !deleg->hasCompileError()))

                continue;

            if (deleg->getType() != getType())

            {

                LogManager::getSingleton().logError("unified program '" + getName() +

                                                    "' delegating to program with different type '" + dn + "'");

                continue;

            }

            mChosenDelegate = deleg;

            break;

        }

    }

    //-----------------------------------------------------------------------

    const GpuProgramPtr& UnifiedHighLevelGpuProgram::_getDelegate() const

    {

        if (!mChosenDelegate)

        {

            chooseDelegate();

        }

        return mChosenDelegate;

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::addDelegateProgram(const String& name)

    {

            OGRE_LOCK_AUTO_MUTEX;

        mDelegateNames.push_back(name);

        // reset chosen delegate

        mChosenDelegate.reset();

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::clearDelegatePrograms()

    {

            OGRE_LOCK_AUTO_MUTEX;

        mDelegateNames.clear();

        mChosenDelegate.reset();

    }

    //-----------------------------------------------------------------------------

    size_t UnifiedHighLevelGpuProgram::calculateSize(void) const

    {

        size_t memSize = 0;

        memSize += GpuProgram::calculateSize();

        // Delegate Names

        for (const auto& n : mDelegateNames)

            memSize += n.size() * sizeof(char);

        return memSize;

    }

    //-----------------------------------------------------------------------

    const String& UnifiedHighLevelGpuProgram::getLanguage(void) const

    {

        return sLanguage;

    }

    //-----------------------------------------------------------------------

    GpuProgramParametersSharedPtr UnifiedHighLevelGpuProgram::createParameters(void)

    {

        if (isSupported())

        {

            return _getDelegate()->createParameters();

        }

        else

        {

            // return a default set

            GpuProgramParametersSharedPtr params = GpuProgramManager::getSingleton().createParameters();

            // avoid any errors on parameter names that don't exist

            params->setIgnoreMissingParams(true);

            return params;

        }

    }

    //-----------------------------------------------------------------------

    GpuProgram* UnifiedHighLevelGpuProgram::_getBindingDelegate(void)

    {

        if (_getDelegate())

            return _getDelegate()->_getBindingDelegate();

        else

            return 0;

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::isSupported(void) const

    {

        // Supported if one of the delegates is

        return _getDelegate() && _getDelegate()->isSupported();

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::isSkeletalAnimationIncluded(void) const

    {

        if (_getDelegate())

            return _getDelegate()->isSkeletalAnimationIncluded();

        else

            return false;

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::isMorphAnimationIncluded(void) const

    {

        if (_getDelegate())

            return _getDelegate()->isMorphAnimationIncluded();

        else

            return false;

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::isPoseAnimationIncluded(void) const

    {

        if (_getDelegate())

            return _getDelegate()->isPoseAnimationIncluded();

        else

            return false;

    }

    //-----------------------------------------------------------------------

    ushort UnifiedHighLevelGpuProgram::getNumberOfPosesIncluded(void) const

    {

        if (_getDelegate())

            return _getDelegate()->getNumberOfPosesIncluded();

        else

            return 0;

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::isVertexTextureFetchRequired(void) const

    {

        if (_getDelegate())

            return _getDelegate()->isVertexTextureFetchRequired();

        else

            return false;

    }

    //-----------------------------------------------------------------------

    const GpuProgramParametersPtr& UnifiedHighLevelGpuProgram::getDefaultParameters(void)

    {

        if (_getDelegate())

            return _getDelegate()->getDefaultParameters();

        static GpuProgramParametersSharedPtr nullPtr;

        return nullPtr;

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::hasDefaultParameters(void) const

    {

        if (_getDelegate())

            return _getDelegate()->hasDefaultParameters();

        else

            return false;

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::getPassSurfaceAndLightStates(void) const

    {

        if (_getDelegate())

            return _getDelegate()->getPassSurfaceAndLightStates();

        else

            return GpuProgram::getPassSurfaceAndLightStates();

    }

    //---------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::getPassFogStates(void) const

    {

        if (_getDelegate())

            return _getDelegate()->getPassFogStates();

        else

            return GpuProgram::getPassFogStates();

    }

    //---------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::getPassTransformStates(void) const

    {

        if (_getDelegate())

            return _getDelegate()->getPassTransformStates();

        else

            return GpuProgram::getPassTransformStates();

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::hasCompileError(void) const

    {

        if (!_getDelegate())

        {

            return false;

        }

        else

        {

            return _getDelegate()->hasCompileError();

        }

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::resetCompileError(void)

    {

        if (_getDelegate())

            _getDelegate()->resetCompileError();

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::load(bool backgroundThread)

    {

        if (_getDelegate())

            _getDelegate()->load(backgroundThread);

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::reload(LoadingFlags flags)

    {

        if (_getDelegate())

            _getDelegate()->reload(flags);

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::isReloadable(void) const

    {

        if (_getDelegate())

            return _getDelegate()->isReloadable();

        else

            return true;

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::unload(void)

    {

        if (_getDelegate())

            _getDelegate()->unload();

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::isLoaded(void) const

    {

        if (_getDelegate())

            return _getDelegate()->isLoaded();

        else

            return false;

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::isLoading() const

    {

        if (_getDelegate())

            return _getDelegate()->isLoading();

        else

            return false;

    }

    //-----------------------------------------------------------------------

    Resource::LoadingState UnifiedHighLevelGpuProgram::getLoadingState() const

    {

        if (_getDelegate())

            return _getDelegate()->getLoadingState();

        else

            return Resource::LOADSTATE_UNLOADED;

    }

    //-----------------------------------------------------------------------

    size_t UnifiedHighLevelGpuProgram::getSize(void) const

    {

        if (_getDelegate())

            return _getDelegate()->getSize();

        else

            return 0;

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::touch(void)

    {

        if (_getDelegate())

            _getDelegate()->touch();

    }

    //-----------------------------------------------------------------------

    bool UnifiedHighLevelGpuProgram::isBackgroundLoaded(void) const

    {

        if (_getDelegate())

            return _getDelegate()->isBackgroundLoaded();

        else

            return false;

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::setBackgroundLoaded(bool bl)

    {

        if (_getDelegate())

            _getDelegate()->setBackgroundLoaded(bl);

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::escalateLoading()

    {

        if (_getDelegate())

            _getDelegate()->escalateLoading();

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::addListener(Resource::Listener* lis)

    {

        if (_getDelegate())

            _getDelegate()->addListener(lis);

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::removeListener(Resource::Listener* lis)

    {

        if (_getDelegate())

            _getDelegate()->removeListener(lis);

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::createLowLevelImpl(void)

    {

        OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED,

            "This method should never get called!",

            "UnifiedHighLevelGpuProgram::createLowLevelImpl");

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::unloadHighLevelImpl(void)

    {

        OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED,

            "This method should never get called!",

            "UnifiedHighLevelGpuProgram::unloadHighLevelImpl");

    }

    //-----------------------------------------------------------------------

    void UnifiedHighLevelGpuProgram::loadFromSource(void)

    {

        OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED,

            "This method should never get called!",

            "UnifiedHighLevelGpuProgram::loadFromSource");

    }

    //-----------------------------------------------------------------------

    //-----------------------------------------------------------------------

    String CmdDelegate::doGet(const void* target) const

    {

        // Can't do this (not one delegate), shouldn't matter

        return BLANKSTRING;

    }

    //-----------------------------------------------------------------------

    void CmdDelegate::doSet(void* target, const String& val)

    {

        static_cast<UnifiedHighLevelGpuProgram*>(target)->addDelegateProgram(val);

    }

    //-----------------------------------------------------------------------

    //-----------------------------------------------------------------------

    UnifiedHighLevelGpuProgramFactory::UnifiedHighLevelGpuProgramFactory()

    {

    }

    //-----------------------------------------------------------------------

    UnifiedHighLevelGpuProgramFactory::~UnifiedHighLevelGpuProgramFactory()

    {

    }

    //-----------------------------------------------------------------------

    const String& UnifiedHighLevelGpuProgramFactory::getLanguage(void) const

    {

        return sLanguage;

    }

    //-----------------------------------------------------------------------

    GpuProgram* UnifiedHighLevelGpuProgramFactory::create(ResourceManager* creator,

        const String& name, ResourceHandle handle,

        const String& group, bool isManual, ManualResourceLoader* loader)

    {

        return OGRE_NEW UnifiedHighLevelGpuProgram(creator, name, handle, group, isManual, loader);

    }

}