michael@0: /*
michael@0:  * Copyright (C) 2012 Apple Inc. All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  * 1. Redistributions of source code must retain the above copyright
michael@0:  *    notice, this list of conditions and the following disclaimer.
michael@0:  * 2. Redistributions in binary form must reproduce the above copyright
michael@0:  *    notice, this list of conditions and the following disclaimer in the
michael@0:  *    documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY APPLE, INC. ``AS IS'' AND ANY
michael@0:  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
michael@0:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
michael@0:  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE, INC. OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
michael@0:  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
michael@0:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: 
michael@0: #ifndef THIRD_PARTY_COMPILER_ARRAY_BOUNDS_CLAMPER_H_
michael@0: #define THIRD_PARTY_COMPILER_ARRAY_BOUNDS_CLAMPER_H_
michael@0: 
michael@0: #include "GLSLANG/ShaderLang.h"
michael@0: 
michael@0: #include "compiler/InfoSink.h"
michael@0: #include "compiler/intermediate.h"
michael@0: 
michael@0: class ArrayBoundsClamper {
michael@0: public:
michael@0:     ArrayBoundsClamper();
michael@0: 
michael@0:     // Must be set before compiling any shaders to ensure consistency
michael@0:     // between the translated shaders and any necessary prequel.
michael@0:     void SetClampingStrategy(ShArrayIndexClampingStrategy clampingStrategy);
michael@0: 
michael@0:     // Marks nodes in the tree that index arrays indirectly as
michael@0:     // requiring clamping.
michael@0:     void MarkIndirectArrayBoundsForClamping(TIntermNode* root);
michael@0: 
michael@0:     // If necessary, output array clamp function source into the shader source.
michael@0:     void OutputClampingFunctionDefinition(TInfoSinkBase& out) const;
michael@0: 
michael@0:     void Cleanup()
michael@0:     {
michael@0:         mArrayBoundsClampDefinitionNeeded = false;
michael@0:     }
michael@0: 
michael@0: private:
michael@0:     bool GetArrayBoundsClampDefinitionNeeded() const { return mArrayBoundsClampDefinitionNeeded; }
michael@0:     void SetArrayBoundsClampDefinitionNeeded() { mArrayBoundsClampDefinitionNeeded = true; }
michael@0: 
michael@0:     ShArrayIndexClampingStrategy mClampingStrategy;
michael@0:     bool mArrayBoundsClampDefinitionNeeded;
michael@0: };
michael@0: 
michael@0: #endif // THIRD_PARTY_COMPILER_ARRAY_BOUNDS_CLAMPER_H_