Files
carbon-lang/executable_semantics/interpreter/address.h
T
Jon Meow ffa4e76ede Add underscores to private data members (#898)
This is the last PR I plan to have focused on #720
2021-10-19 14:27:10 -07:00

71 lines
2.3 KiB
C++

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#ifndef EXECUTABLE_SEMANTICS_INTERPRETER_ADDRESS_H_
#define EXECUTABLE_SEMANTICS_INTERPRETER_ADDRESS_H_
#include <cstdint>
#include <string>
#include <vector>
#include "common/ostream.h"
#include "executable_semantics/interpreter/field_path.h"
#include "llvm/Support/Compiler.h"
namespace Carbon {
// An Address represents a memory address in the Carbon virtual machine.
// Addresses are used to access values stored in a Heap, and are obtained
// from a Heap (or by deriving them from other Addresses).
class Address {
public:
Address(const Address&) = default;
Address(Address&&) = default;
auto operator=(const Address&) -> Address& = default;
auto operator=(Address&&) -> Address& = default;
// Returns true if the two addresses refer to the same memory location.
friend auto operator==(const Address& lhs, const Address& rhs) -> bool {
return lhs.index_ == rhs.index_;
}
friend auto operator!=(const Address& lhs, const Address& rhs) -> bool {
return !(lhs == rhs);
}
// Prints a human-readable representation of `a` to `out`.
//
// Currently, that representation consists of an integer index identifying
// the whole memory allocation, and an optional FieldPath specifying a
// particular field within that allocation.
void Print(llvm::raw_ostream& out) const {
out << "Address(" << index_ << ")" << field_path_;
}
LLVM_DUMP_METHOD void Dump() const { Print(llvm::errs()); }
// If *this represents the address of an object with a field named
// `field_name`, this method returns the address of that field.
auto SubobjectAddress(std::string field_name) const -> Address {
Address result = *this;
result.field_path_.Append(std::move(field_name));
return result;
}
private:
// The representation of Address describes how to locate an object within
// the Heap, so its implementation details are tied to the implementation
// details of the Heap.
friend class Heap;
explicit Address(uint64_t index) : index_(index) {}
uint64_t index_;
FieldPath field_path_;
};
} // namespace Carbon
#endif // EXECUTABLE_SEMANTICS_INTERPRETER_ADDRESS_H_