1/*
2 * Copyright (C) 2012 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE, INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE, INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef THIRD_PARTY_COMPILER_ARRAYBOUNDSCLAMPER_H_
27#define THIRD_PARTY_COMPILER_ARRAYBOUNDSCLAMPER_H_
28
29#include "compiler/translator/InfoSink.h"
30#include "compiler/translator/IntermNode.h"
31
32namespace sh
33{
34
35class ArrayBoundsClamper
36{
37 public:
38 ArrayBoundsClamper();
39
40 // Must be set before compiling any shaders to ensure consistency
41 // between the translated shaders and any necessary prequel.
42 void SetClampingStrategy(ShArrayIndexClampingStrategy clampingStrategy);
43
44 // Marks nodes in the tree that index arrays indirectly as
45 // requiring clamping.
46 void MarkIndirectArrayBoundsForClamping(TIntermNode *root);
47
48 // If necessary, output array clamp function source into the shader source.
49 void OutputClampingFunctionDefinition(TInfoSinkBase &out) const;
50
51 void Cleanup() { mArrayBoundsClampDefinitionNeeded = false; }
52
53 private:
54 bool GetArrayBoundsClampDefinitionNeeded() const { return mArrayBoundsClampDefinitionNeeded; }
55 void SetArrayBoundsClampDefinitionNeeded() { mArrayBoundsClampDefinitionNeeded = true; }
56
57 ShArrayIndexClampingStrategy mClampingStrategy;
58 bool mArrayBoundsClampDefinitionNeeded;
59};
60
61} // namespace sh
62
63#endif // THIRD_PARTY_COMPILER_ARRAYBOUNDSCLAMPER_H_
64