blob: c33c1a004144aef9a9ba077378ae3da0e465f3cd [file] [log] [blame]
/*
* Copyright 2016 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef SKSL_EXPRESSION
#define SKSL_EXPRESSION
#include "src/sksl/ir/SkSLType.h"
#include "src/sksl/ir/SkSLVariable.h"
#include <unordered_map>
namespace SkSL {
struct Expression;
class IRGenerator;
typedef std::unordered_map<const Variable*, std::unique_ptr<Expression>*> DefinitionMap;
/**
* Abstract supertype of all expressions.
*/
struct Expression : public IRNode {
enum Kind {
kBinary_Kind,
kBoolLiteral_Kind,
kConstructor_Kind,
kExternalFunctionCall_Kind,
kExternalValue_Kind,
kIntLiteral_Kind,
kFieldAccess_Kind,
kFloatLiteral_Kind,
kFunctionReference_Kind,
kFunctionCall_Kind,
kIndex_Kind,
kNullLiteral_Kind,
kPrefix_Kind,
kPostfix_Kind,
kSetting_Kind,
kSwizzle_Kind,
kVariableReference_Kind,
kTernary_Kind,
kTypeReference_Kind,
kDefined_Kind
};
enum class Property {
kSideEffects,
kContainsRTAdjust
};
Expression(int offset, Kind kind, const Type& type)
: INHERITED(offset)
, fKind(kind)
, fType(std::move(type)) {}
/**
* Returns true if this expression is constant. compareConstant must be implemented for all
* constants!
*/
virtual bool isConstant() const {
return false;
}
/**
* Compares this constant expression against another constant expression of the same type. It is
* an error to call this on non-constant expressions, or if the types of the expressions do not
* match.
*/
virtual bool compareConstant(const Context& context, const Expression& other) const {
ABORT("cannot call compareConstant on this type");
}
/**
* For an expression which evaluates to a constant int, returns the value. Otherwise calls
* ABORT.
*/
virtual int64_t getConstantInt() const {
ABORT("not a constant int");
}
/**
* For an expression which evaluates to a constant float, returns the value. Otherwise calls
* ABORT.
*/
virtual double getConstantFloat() const {
ABORT("not a constant float");
}
/**
* Returns true if, given fixed values for uniforms, this expression always evaluates to the
* same result with no side effects.
*/
virtual bool isConstantOrUniform() const {
SkASSERT(!this->isConstant() || !this->hasSideEffects());
return this->isConstant();
}
virtual bool hasProperty(Property property) const = 0;
bool hasSideEffects() const {
return this->hasProperty(Property::kSideEffects);
}
bool containsRTAdjust() const {
return this->hasProperty(Property::kContainsRTAdjust);
}
/**
* Given a map of known constant variable values, substitute them in for references to those
* variables occurring in this expression and its subexpressions. Similar simplifications, such
* as folding a constant binary expression down to a single value, may also be performed.
* Returns a new expression which replaces this expression, or null if no replacements were
* made. If a new expression is returned, this expression is no longer valid.
*/
virtual std::unique_ptr<Expression> constantPropagate(const IRGenerator& irGenerator,
const DefinitionMap& definitions) {
return nullptr;
}
virtual int coercionCost(const Type& target) const {
return fType.coercionCost(target);
}
/**
* For a literal vector expression, return the floating point value of the n'th vector
* component. It is an error to call this method on an expression which is not a literal vector.
*/
virtual SKSL_FLOAT getFVecComponent(int n) const {
SkASSERT(false);
return 0;
}
/**
* For a literal vector expression, return the integer value of the n'th vector component. It is
* an error to call this method on an expression which is not a literal vector.
*/
virtual SKSL_INT getIVecComponent(int n) const {
SkASSERT(false);
return 0;
}
/**
* For a literal matrix expression, return the floating point value of the component at
* [col][row]. It is an error to call this method on an expression which is not a literal
* matrix.
*/
virtual SKSL_FLOAT getMatComponent(int col, int row) const {
SkASSERT(false);
return 0;
}
virtual std::unique_ptr<Expression> clone() const = 0;
const Kind fKind;
const Type& fType;
typedef IRNode INHERITED;
};
} // namespace
#endif