skia2/tests/SkSLDSLErrorLineNumbers.cpp
Kevin Lubick 08ece0c9a0 [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-21 12:43:02 +00:00

123 lines
3.6 KiB
C++

/*
* Copyright 2021 Google LLC.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#include "include/gpu/GrDirectContext.h"
#include "include/sksl/DSL.h"
#include "include/sksl/DSLCore.h"
#include "include/sksl/DSLExpression.h"
#include "include/sksl/DSLStatement.h"
#include "include/sksl/DSLType.h"
#include "include/sksl/DSLVar.h"
#include "include/sksl/DSLWrapper.h"
#include "include/sksl/SkSLErrorReporter.h"
#include "include/sksl/SkSLPosition.h"
#include "src/gpu/GrDirectContextPriv.h"
#include "src/gpu/GrGpu.h"
#include "src/sksl/SkSLCompiler.h"
#include "src/sksl/SkSLThreadContext.h"
#include "src/sksl/dsl/priv/DSLWriter.h"
#include "tests/Test.h"
#include "tools/gpu/GrContextFactory.h"
#include <string>
#include <string_view>
using namespace SkSL::dsl;
#if defined(__GNUC__) || defined(__clang__)
class ExpectErrorLineNumber : public SkSL::ErrorReporter {
public:
ExpectErrorLineNumber(skiatest::Reporter* reporter, const char* msg, int line)
: fMsg(msg)
, fLine(line)
, fReporter(reporter)
, fOldReporter(&GetErrorReporter()) {
SetErrorReporter(this);
}
~ExpectErrorLineNumber() override {
REPORTER_ASSERT(fReporter, !fMsg);
SetErrorReporter(fOldReporter);
}
void handleError(std::string_view msg, SkSL::Position pos) override {
REPORTER_ASSERT(fReporter, msg == fMsg,
"Error mismatch: expected:\n%sbut received:\n%.*s", fMsg, (int)msg.length(),
msg.data());
REPORTER_ASSERT(fReporter, pos.line() == fLine,
"Line number mismatch: expected %d, but received %d\n", fLine, pos.line());
SkSL::ThreadContext::Compiler().handleError(msg, pos);
fMsg = nullptr;
}
private:
const char* fMsg;
int fLine;
skiatest::Reporter* fReporter;
ErrorReporter* fOldReporter;
};
DEF_GPUTEST_FOR_MOCK_CONTEXT(DSLErrorLineNumbers, r, ctxInfo) {
Start(ctxInfo.directContext()->priv().getGpu()->shaderCompiler());
{
ExpectErrorLineNumber error(r, "type mismatch: '+' cannot operate on 'float', 'bool'",
__LINE__ + 1);
(Float(1) + true).release();
}
{
Var a(kBool_Type);
DSLWriter::MarkDeclared(a);
ExpectErrorLineNumber error(r, "type mismatch: '=' cannot operate on 'bool', 'float'",
__LINE__ + 1);
(a = 5.0f).release();
}
{
Var a(Array(kInt_Type, 5));
DSLWriter::MarkDeclared(a);
ExpectErrorLineNumber error(r, "expected 'int', but found 'bool'", __LINE__ + 1);
(a[true]).release();
}
{
Var a(Array(kInt_Type, 5));
DSLWriter::MarkDeclared(a);
ExpectErrorLineNumber error(r, "'++' cannot operate on 'int[5]'", __LINE__ + 1);
(++a).release();
}
{
ExpectErrorLineNumber error(r, "expected 'bool', but found 'int'", __LINE__ + 1);
Do(Discard(), 5).release();
}
{
ExpectErrorLineNumber error(r, "expected 'bool', but found 'int'", __LINE__ + 1);
For(DSLStatement(), 5, DSLExpression(), Block()).release();
}
{
ExpectErrorLineNumber error(r, "expected 'bool', but found 'int'", __LINE__ + 1);
If(5, Discard()).release();
}
{
ExpectErrorLineNumber error(r, "expected 'bool', but found 'int'", __LINE__ + 1);
While(5, Discard()).release();
}
{
ExpectErrorLineNumber error(r, "no match for abs(bool)", __LINE__ + 1);
Abs(true).release();
}
End();
}
#endif // defined(__GNUC__) || defined(__clang__)