src/third_party/angle/src/third_party/compiler/ArrayBoundsClamper.h

   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_ARRAY_BOUNDS_CLAMPER_H_
  27 #define THIRD_PARTY_COMPILER_ARRAY_BOUNDS_CLAMPER_H_
  28
  29 #include "compiler/translator/InfoSink.h"
  30 #include "compiler/translator/IntermNode.h"
  31
  32 class ArrayBoundsClamper {
  33 public:
  34     ArrayBoundsClamper();
  35
  36     // Must be set before compiling any shaders to ensure consistency
  37     // between the translated shaders and any necessary prequel.
  38     void SetClampingStrategy(ShArrayIndexClampingStrategy clampingStrategy);
  39
  40     // Marks nodes in the tree that index arrays indirectly as
  41     // requiring clamping.
  42     void MarkIndirectArrayBoundsForClamping(TIntermNode* root);
  43
  44     // If necessary, output array clamp function source into the shader source.
  45     void OutputClampingFunctionDefinition(TInfoSinkBase& out) const;
  46
  47     void Cleanup()
  48     {
  49         mArrayBoundsClampDefinitionNeeded = false;
  50     }
  51
  52 private:
  53     bool GetArrayBoundsClampDefinitionNeeded() const { return mArrayBoundsClampDefinitionNeeded; }
  54     void SetArrayBoundsClampDefinitionNeeded() { mArrayBoundsClampDefinitionNeeded = true; }
  55
  56     ShArrayIndexClampingStrategy mClampingStrategy;
  57     bool mArrayBoundsClampDefinitionNeeded;
  58 };
  59
  60 #endif // THIRD_PARTY_COMPILER_ARRAY_BOUNDS_CLAMPER_H_