1/**************************************************************************/
2/* shader_warnings.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef SHADER_WARNINGS_H
32#define SHADER_WARNINGS_H
33
34#ifdef DEBUG_ENABLED
35
36#include "core/string/string_name.h"
37#include "core/templates/hash_map.h"
38#include "core/templates/list.h"
39#include "core/templates/rb_map.h"
40#include "core/variant/variant.h"
41
42class ShaderWarning {
43public:
44 enum Code {
45 FLOAT_COMPARISON,
46 UNUSED_CONSTANT,
47 UNUSED_FUNCTION,
48 UNUSED_STRUCT,
49 UNUSED_UNIFORM,
50 UNUSED_VARYING,
51 UNUSED_LOCAL_VARIABLE,
52 FORMATTING_ERROR,
53 DEVICE_LIMIT_EXCEEDED,
54 WARNING_MAX,
55 };
56
57 enum CodeFlags : uint32_t {
58 NONE_FLAG = 0U,
59 FLOAT_COMPARISON_FLAG = 1U,
60 UNUSED_CONSTANT_FLAG = 2U,
61 UNUSED_FUNCTION_FLAG = 4U,
62 UNUSED_STRUCT_FLAG = 8U,
63 UNUSED_UNIFORM_FLAG = 16U,
64 UNUSED_VARYING_FLAG = 32U,
65 UNUSED_LOCAL_VARIABLE_FLAG = 64U,
66 FORMATTING_ERROR_FLAG = 128U,
67 DEVICE_LIMIT_EXCEEDED_FLAG = 256U,
68 };
69
70private:
71 Code code;
72 int line;
73 StringName subject;
74 Vector<Variant> extra_args;
75
76public:
77 Code get_code() const;
78 int get_line() const;
79 const StringName &get_subject() const;
80 String get_message() const;
81 String get_name() const;
82 Vector<Variant> get_extra_args() const;
83
84 static String get_name_from_code(Code p_code);
85 static Code get_code_from_name(const String &p_name);
86 static CodeFlags get_flags_from_codemap(const HashMap<Code, bool> &p_map);
87
88 ShaderWarning(Code p_code = WARNING_MAX, int p_line = -1, const StringName &p_subject = "", const Vector<Variant> &p_extra_args = Vector<Variant>());
89};
90
91#endif // DEBUG_ENABLED
92
93#endif // SHADER_WARNINGS_H
94