blob: a41e943c3a0a79ec9b5b5d6d6d9d2c8101c0705e [file] [log] [blame]
Ryan Harrisondbc13af2022-02-21 15:19:07 +00001// Copyright 2020 The Tint Authors.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#ifndef SRC_TINT_AST_LOCATION_ATTRIBUTE_H_
16#define SRC_TINT_AST_LOCATION_ATTRIBUTE_H_
17
18#include <string>
19
20#include "src/tint/ast/attribute.h"
dan sinclairf9eeed62022-09-07 22:25:24 +000021#include "src/tint/ast/expression.h"
Ryan Harrisondbc13af2022-02-21 15:19:07 +000022
dan sinclair34323ac2022-04-07 18:39:35 +000023namespace tint::ast {
Ryan Harrisondbc13af2022-02-21 15:19:07 +000024
25/// A location attribute
Ben Clayton41f8d2a2022-03-07 18:37:46 +000026class LocationAttribute final : public Castable<LocationAttribute, Attribute> {
dan sinclair41e4d9a2022-05-01 14:40:55 +000027 public:
28 /// constructor
29 /// @param pid the identifier of the program that owns this node
Ben Clayton4a92a3c2022-07-18 20:50:02 +000030 /// @param nid the unique node identifier
dan sinclair41e4d9a2022-05-01 14:40:55 +000031 /// @param src the source of this node
dan sinclairc4e076f2022-09-08 01:04:34 +000032 /// @param expr the location expression
Ben Clayton5662f792023-02-22 00:08:55 +000033 LocationAttribute(ProgramID pid, NodeID nid, const Source& src, const Expression* expr);
dan sinclair41e4d9a2022-05-01 14:40:55 +000034 ~LocationAttribute() override;
Ryan Harrisondbc13af2022-02-21 15:19:07 +000035
dan sinclair41e4d9a2022-05-01 14:40:55 +000036 /// @returns the WGSL name for the attribute
37 std::string Name() const override;
Ryan Harrisondbc13af2022-02-21 15:19:07 +000038
dan sinclair41e4d9a2022-05-01 14:40:55 +000039 /// Clones this node and all transitive child nodes using the `CloneContext`
40 /// `ctx`.
41 /// @param ctx the clone context
42 /// @return the newly cloned node
43 const LocationAttribute* Clone(CloneContext* ctx) const override;
Ryan Harrisondbc13af2022-02-21 15:19:07 +000044
dan sinclairc4e076f2022-09-08 01:04:34 +000045 /// The location expression
Ben Clayton5662f792023-02-22 00:08:55 +000046 const Expression* const expr;
Ryan Harrisondbc13af2022-02-21 15:19:07 +000047};
48
dan sinclair34323ac2022-04-07 18:39:35 +000049} // namespace tint::ast
Ryan Harrisondbc13af2022-02-21 15:19:07 +000050
51#endif // SRC_TINT_AST_LOCATION_ATTRIBUTE_H_