Source/platform/graphics/filters/custom/CustomFilterProgramInfo.h

/*
 * Copyright (C) 2012 Adobe Systems Incorporated. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer.
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER “AS IS” AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef CustomFilterProgramInfo_h
#define CustomFilterProgramInfo_h

#include "platform/PlatformExport.h"
#include "platform/graphics/GraphicsTypes.h"
#include "platform/graphics/filters/custom/CustomFilterConstants.h"
#include "wtf/HashTableDeletedValueType.h"
#include "wtf/HashTraits.h"
#include "wtf/text/WTFString.h"

namespace WebCore {


struct CustomFilterProgramMixSettings {
    CustomFilterProgramMixSettings()
        : blendMode(blink::WebBlendModeNormal)
        , compositeOperator(CompositeSourceAtop)
    {
    }

    bool operator==(const CustomFilterProgramMixSettings& o) const
    {
        return blendMode == o.blendMode && compositeOperator == o.compositeOperator;
    }

    blink::WebBlendMode blendMode;
    CompositeOperator compositeOperator;
};

// CustomFilterProgramInfo is the key used to link CustomFilterProgram with CustomFilterCompiledProgram.
// It can be used as a key in a HashMap, with the note that at least one of Strings needs to be non-null.
// Null strings are placeholders for the default shader.
class PLATFORM_EXPORT CustomFilterProgramInfo {
public:
    CustomFilterProgramInfo(const String&, const String&, CustomFilterProgramType, const CustomFilterProgramMixSettings&, CustomFilterMeshType);

    CustomFilterProgramInfo();
    bool isEmptyValue() const;

    CustomFilterProgramInfo(WTF::HashTableDeletedValueType);
    bool isHashTableDeletedValue() const;

    unsigned hash() const;
    bool operator==(const CustomFilterProgramInfo&) const;

    const String& vertexShaderString() const { return m_vertexShaderString; }
    const String& fragmentShaderString() const { return m_fragmentShaderString; }
    CustomFilterProgramType programType() const { return m_programType; }
    const CustomFilterProgramMixSettings& mixSettings() const { return m_mixSettings; }
    CustomFilterMeshType meshType() const { return m_meshType; }
private:
    String m_vertexShaderString;
    String m_fragmentShaderString;
    CustomFilterProgramType m_programType;
    CustomFilterProgramMixSettings m_mixSettings;
    CustomFilterMeshType m_meshType;
};

struct CustomFilterProgramInfoHash {
    static unsigned hash(const CustomFilterProgramInfo& programInfo) { return programInfo.hash(); }
    static bool equal(const CustomFilterProgramInfo& a, const CustomFilterProgramInfo& b) { return a == b; }
    static const bool safeToCompareToEmptyOrDeleted = false;
};

struct CustomFilterProgramInfoHashTraits : WTF::SimpleClassHashTraits<CustomFilterProgramInfo> {
    static const bool hasIsEmptyValueFunction = true;
    static bool isEmptyValue(const CustomFilterProgramInfo& info) { return info.isEmptyValue(); }
};

} // namespace WebCore

namespace WTF {

template<> struct HashTraits<WebCore::CustomFilterProgramInfo> : WebCore::CustomFilterProgramInfoHashTraits { };
template<> struct DefaultHash<WebCore::CustomFilterProgramInfo> {
    typedef WebCore::CustomFilterProgramInfoHash Hash;
};

}

#endif // CustomFilterProgramInfo_h