skia2/include/sksl/DSLFunction.h

117 lines
3.6 KiB
C
Raw Normal View History

/*
* Copyright 2021 Google LLC.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef SKSL_DSL_FUNCTION
#define SKSL_DSL_FUNCTION
[includes] Enforce IWYU on sksl code PS1 regenerates the Bazel files. Use it as the base change when comparing patchsets. IWYU seems to do a good job of working with MyFile.cpp and MyFile.h, but if there is just a MyHeader.h, it doesn't always seem to throw errors if the includes aren't correct. This was observed with include/sksl/DSL.h This might be due to the fact that headers are not compiled on their own, so they are never sent directly to the IWYU binary. This change sets enforce_iwyu_on_package() on the all sksl packages and then fixes the includes until all those checks are happy. There were a few files that needed fixes outside of the sksl folder. Examples include: - src/gpu/effects/GrConvexPolyEffect.cpp - tests/SkSLDSLTest.cpp To really enforce this, we need to add a CI/CQ job that runs bazel build //example:hello_world_gl --config=clang \ --sandbox_base=/dev/shm --features skia_enforce_iwyu If that failed, a dev could make the changes described in the logs and/or run the command locally to see those prescribed fixes. I had to add several entries to toolchain/IWYU_mapping.imp in order to fix some private includes and other atypical choices. I tried adding a rule there to allow inclusion of SkTypes.h to make sure defines like SK_SUPPORT_GPU, but could not get it to work for all cases, so I deferred to using the IWYU pragma: keep (e.g. SkSLPipelineStageCodeGenerator.h) Change-Id: I4c3e536d8e69ff7ff2d26fe61a525a6c2e80db06 Bug: skia:13052 Reviewed-on: https://skia-review.googlesource.com/c/skia/+/522256 Reviewed-by: John Stiles <johnstiles@google.com> Reviewed-by: Greg Daniel <egdaniel@google.com>
2022-03-18 20:40:58 +00:00
#include "include/private/SkSLDefines.h"
#include "include/private/SkTArray.h"
#include "include/sksl/DSLBlock.h"
#include "include/sksl/DSLExpression.h"
[includes] Enforce IWYU on sksl code PS1 regenerates the Bazel files. Use it as the base change when comparing patchsets. IWYU seems to do a good job of working with MyFile.cpp and MyFile.h, but if there is just a MyHeader.h, it doesn't always seem to throw errors if the includes aren't correct. This was observed with include/sksl/DSL.h This might be due to the fact that headers are not compiled on their own, so they are never sent directly to the IWYU binary. This change sets enforce_iwyu_on_package() on the all sksl packages and then fixes the includes until all those checks are happy. There were a few files that needed fixes outside of the sksl folder. Examples include: - src/gpu/effects/GrConvexPolyEffect.cpp - tests/SkSLDSLTest.cpp To really enforce this, we need to add a CI/CQ job that runs bazel build //example:hello_world_gl --config=clang \ --sandbox_base=/dev/shm --features skia_enforce_iwyu If that failed, a dev could make the changes described in the logs and/or run the command locally to see those prescribed fixes. I had to add several entries to toolchain/IWYU_mapping.imp in order to fix some private includes and other atypical choices. I tried adding a rule there to allow inclusion of SkTypes.h to make sure defines like SK_SUPPORT_GPU, but could not get it to work for all cases, so I deferred to using the IWYU pragma: keep (e.g. SkSLPipelineStageCodeGenerator.h) Change-Id: I4c3e536d8e69ff7ff2d26fe61a525a6c2e80db06 Bug: skia:13052 Reviewed-on: https://skia-review.googlesource.com/c/skia/+/522256 Reviewed-by: John Stiles <johnstiles@google.com> Reviewed-by: Greg Daniel <egdaniel@google.com>
2022-03-18 20:40:58 +00:00
#include "include/sksl/DSLModifiers.h"
#include "include/sksl/DSLStatement.h"
#include "include/sksl/DSLVar.h"
[includes] Enforce IWYU on sksl code PS1 regenerates the Bazel files. Use it as the base change when comparing patchsets. IWYU seems to do a good job of working with MyFile.cpp and MyFile.h, but if there is just a MyHeader.h, it doesn't always seem to throw errors if the includes aren't correct. This was observed with include/sksl/DSL.h This might be due to the fact that headers are not compiled on their own, so they are never sent directly to the IWYU binary. This change sets enforce_iwyu_on_package() on the all sksl packages and then fixes the includes until all those checks are happy. There were a few files that needed fixes outside of the sksl folder. Examples include: - src/gpu/effects/GrConvexPolyEffect.cpp - tests/SkSLDSLTest.cpp To really enforce this, we need to add a CI/CQ job that runs bazel build //example:hello_world_gl --config=clang \ --sandbox_base=/dev/shm --features skia_enforce_iwyu If that failed, a dev could make the changes described in the logs and/or run the command locally to see those prescribed fixes. I had to add several entries to toolchain/IWYU_mapping.imp in order to fix some private includes and other atypical choices. I tried adding a rule there to allow inclusion of SkTypes.h to make sure defines like SK_SUPPORT_GPU, but could not get it to work for all cases, so I deferred to using the IWYU pragma: keep (e.g. SkSLPipelineStageCodeGenerator.h) Change-Id: I4c3e536d8e69ff7ff2d26fe61a525a6c2e80db06 Bug: skia:13052 Reviewed-on: https://skia-review.googlesource.com/c/skia/+/522256 Reviewed-by: John Stiles <johnstiles@google.com> Reviewed-by: Greg Daniel <egdaniel@google.com>
2022-03-18 20:40:58 +00:00
#include "include/sksl/SkSLPosition.h"
#include <string_view>
#include <utility>
namespace SkSL {
class FunctionDeclaration;
namespace dsl {
class DSLType;
class DSLFunction {
public:
template<class... Parameters>
DSLFunction(const DSLType& returnType, std::string_view name, Parameters&... parameters)
: DSLFunction(DSLModifiers(), returnType, name, parameters...) {}
template<class... Parameters>
DSLFunction(const DSLModifiers& modifiers, const DSLType& returnType, std::string_view name,
Parameters&... parameters) {
SkTArray<DSLParameter*> parameterArray;
parameterArray.reserve_back(sizeof...(parameters));
(parameterArray.push_back(&parameters), ...);
// We can't have a default parameter and a template parameter pack at the same time, so
// unfortunately we can't capture position from this overload.
this->init(modifiers, returnType, name, std::move(parameterArray), Position());
}
DSLFunction(const DSLType& returnType, std::string_view name,
SkTArray<DSLParameter*> parameters, Position pos = {}) {
this->init(DSLModifiers(), returnType, name, std::move(parameters), pos);
}
DSLFunction(const DSLModifiers& modifiers, const DSLType& returnType, std::string_view name,
SkTArray<DSLParameter*> parameters, Position pos = {}) {
this->init(modifiers, returnType, name, std::move(parameters), pos);
}
DSLFunction(const SkSL::FunctionDeclaration* decl)
: fDecl(decl) {}
virtual ~DSLFunction() = default;
template<class... Stmt>
void define(Stmt... stmts) {
DSLBlock block = DSLBlock(DSLStatement(std::move(stmts))...);
this->define(std::move(block));
}
void define(DSLBlock block, Position pos = {});
/**
* Invokes the function with the given arguments.
*/
template<class... Args>
DSLExpression operator()(Args&&... args) {
ExpressionArray argArray;
argArray.reserve_back(sizeof...(args));
this->collectArgs(argArray, std::forward<Args>(args)...);
return this->call(std::move(argArray));
}
/**
* Invokes the function with the given arguments.
*/
DSLExpression call(SkTArray<DSLExpression> args, Position pos = {});
DSLExpression call(ExpressionArray args, Position pos = {});
private:
void collectArgs(ExpressionArray& args) {}
template<class... RemainingArgs>
void collectArgs(ExpressionArray& args, DSLVar& var, RemainingArgs&&... remaining) {
args.push_back(DSLExpression(var).release());
collectArgs(args, std::forward<RemainingArgs>(remaining)...);
}
template<class... RemainingArgs>
void collectArgs(ExpressionArray& args, DSLExpression expr, RemainingArgs&&... remaining) {
args.push_back(expr.release());
collectArgs(args, std::forward<RemainingArgs>(remaining)...);
}
void init(DSLModifiers modifiers, const DSLType& returnType, std::string_view name,
SkTArray<DSLParameter*> params, Position pos);
const SkSL::FunctionDeclaration* fDecl = nullptr;
SkSL::Position fPosition;
};
} // namespace dsl
} // namespace SkSL
#endif