src/tint/ast/storage_class.h

// Copyright 2022 The Tint Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

////////////////////////////////////////////////////////////////////////////////
// File generated by tools/src/cmd/gen
// using the template:
//   src/tint/ast/storage_class.h.tmpl
//
// Do not modify this file directly
////////////////////////////////////////////////////////////////////////////////

#ifndef SRC_TINT_AST_STORAGE_CLASS_H_
#define SRC_TINT_AST_STORAGE_CLASS_H_

#include <ostream>

namespace tint::ast {

/// Storage class of a given pointer.
enum class StorageClass {
    kInvalid,
    kNone,  // Tint-internal enum entry - not parsed
    kFunction,
    kPrivate,
    kWorkgroup,
    kUniform,
    kStorage,
    kHandle,  // Tint-internal enum entry - not parsed
    kIn,      // Tint-internal enum entry - not parsed
    kOut,     // Tint-internal enum entry - not parsed
};

/// @param out the std::ostream to write to
/// @param value the StorageClass
/// @returns `out` so calls can be chained
std::ostream& operator<<(std::ostream& out, StorageClass value);

/// ParseStorageClass parses a StorageClass from a string.
/// @param str the string to parse
/// @returns the parsed enum, or StorageClass::kInvalid if the string could not be parsed.
StorageClass ParseStorageClass(std::string_view str);

/// @returns true if the StorageClass is host-shareable
/// @param sc the StorageClass
/// @see https://gpuweb.github.io/gpuweb/wgsl.html#host-shareable
inline bool IsHostShareable(StorageClass sc) {
    return sc == ast::StorageClass::kUniform || sc == ast::StorageClass::kStorage;
}

}  // namespace tint::ast

#endif  // SRC_TINT_AST_STORAGE_CLASS_H_