2020-12-10 16:56:02 +00:00
|
|
|
// Copyright 2020 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.
|
|
|
|
|
|
|
|
#ifndef SRC_SYMBOL_TABLE_H_
|
|
|
|
#define SRC_SYMBOL_TABLE_H_
|
|
|
|
|
|
|
|
#include <string>
|
|
|
|
#include <unordered_map>
|
|
|
|
|
|
|
|
#include "src/symbol.h"
|
|
|
|
|
|
|
|
namespace tint {
|
|
|
|
|
|
|
|
/// Holds mappings from symbols to their associated string names
|
|
|
|
class SymbolTable {
|
|
|
|
public:
|
|
|
|
/// Constructor
|
2021-04-15 18:20:03 +00:00
|
|
|
/// @param program_id the identifier of the program that owns this symbol
|
|
|
|
/// table
|
|
|
|
explicit SymbolTable(tint::ProgramID program_id);
|
2020-12-11 18:24:53 +00:00
|
|
|
/// Copy constructor
|
|
|
|
SymbolTable(const SymbolTable&);
|
2020-12-10 16:56:02 +00:00
|
|
|
/// Move Constructor
|
|
|
|
SymbolTable(SymbolTable&&);
|
|
|
|
/// Destructor
|
|
|
|
~SymbolTable();
|
|
|
|
|
2020-12-11 18:24:53 +00:00
|
|
|
/// Copy assignment
|
|
|
|
/// @param other the symbol table to copy
|
|
|
|
/// @returns the new symbol table
|
|
|
|
SymbolTable& operator=(const SymbolTable& other);
|
2020-12-10 16:56:02 +00:00
|
|
|
/// Move assignment
|
|
|
|
/// @param other the symbol table to move
|
|
|
|
/// @returns the symbol table
|
|
|
|
SymbolTable& operator=(SymbolTable&& other);
|
|
|
|
|
|
|
|
/// Registers a name into the symbol table, returning the Symbol.
|
|
|
|
/// @param name the name to register
|
|
|
|
/// @returns the symbol representing the given name
|
|
|
|
Symbol Register(const std::string& name);
|
|
|
|
|
2020-12-11 18:24:53 +00:00
|
|
|
/// Returns the symbol for the given `name`
|
|
|
|
/// @param name the name to lookup
|
|
|
|
/// @returns the symbol for the name or symbol::kInvalid if not found.
|
2021-01-26 16:57:10 +00:00
|
|
|
Symbol Get(const std::string& name) const;
|
2020-12-11 18:24:53 +00:00
|
|
|
|
2020-12-10 16:56:02 +00:00
|
|
|
/// Returns the name for the given symbol
|
|
|
|
/// @param symbol the symbol to retrieve the name for
|
|
|
|
/// @returns the symbol name or "" if not found
|
|
|
|
std::string NameFor(const Symbol symbol) const;
|
|
|
|
|
2021-04-13 20:07:57 +00:00
|
|
|
/// Returns a new unique symbol with the given name, possibly suffixed with a
|
|
|
|
/// unique number.
|
|
|
|
/// @param name the symbol name
|
|
|
|
/// @returns a new, unnamed symbol with the given name. If the name is already
|
|
|
|
/// taken then this will be suffixed with an underscore and a unique numerical
|
|
|
|
/// value
|
|
|
|
Symbol New(std::string name = "tint_symbol");
|
|
|
|
|
|
|
|
/// Foreach calls the callback function `F` for each symbol in the table.
|
|
|
|
/// @param callback must be a function or function-like object with the
|
|
|
|
/// signature: `void(Symbol, const std::string&)`
|
|
|
|
template <typename F>
|
|
|
|
void Foreach(F&& callback) const {
|
|
|
|
for (auto it : symbol_to_name_) {
|
|
|
|
callback(it.first, it.second);
|
|
|
|
}
|
|
|
|
}
|
2021-02-11 14:54:41 +00:00
|
|
|
|
2021-04-15 18:20:03 +00:00
|
|
|
/// @returns the identifier of the Program that owns this symbol table.
|
|
|
|
tint::ProgramID ProgramID() const { return program_id_; }
|
|
|
|
|
2020-12-10 16:56:02 +00:00
|
|
|
private:
|
|
|
|
// The value to be associated to the next registered symbol table entry.
|
|
|
|
uint32_t next_symbol_ = 1;
|
|
|
|
|
2021-01-11 22:02:42 +00:00
|
|
|
std::unordered_map<Symbol, std::string> symbol_to_name_;
|
2020-12-10 16:56:02 +00:00
|
|
|
std::unordered_map<std::string, Symbol> name_to_symbol_;
|
2021-04-15 18:20:03 +00:00
|
|
|
tint::ProgramID program_id_;
|
2020-12-10 16:56:02 +00:00
|
|
|
};
|
|
|
|
|
2021-04-15 18:20:03 +00:00
|
|
|
/// @param symbol_table the SymbolTable
|
|
|
|
/// @returns the ProgramID that owns the given SymbolTable
|
|
|
|
inline ProgramID ProgramIDOf(const SymbolTable& symbol_table) {
|
|
|
|
return symbol_table.ProgramID();
|
|
|
|
}
|
|
|
|
|
2020-12-10 16:56:02 +00:00
|
|
|
} // namespace tint
|
|
|
|
|
|
|
|
#endif // SRC_SYMBOL_TABLE_H_
|