mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-10-04 14:01:06 +01:00
Josh Soref
066b103881
This PR corrects misspellings identified by the [check-spelling action](https://github.com/marketplace/actions/check-spelling). The misspellings have been reported at https://github.com/jsoref/carbon-lang/commit/38a1c1640151899fd6da0442a92557f9543b6280#commitcomment-79197316 The action reports that the changes in this PR would make it happy: https://github.com/jsoref/carbon-lang/commit/173c8f9083a68aa61f7cfe94f720f1e5dc7f1ea3 Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately. Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
88 lines
2.8 KiB
C++
88 lines
2.8 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 CARBON_EXPLORER_INTERPRETER_ADDRESS_H_
|
|
#define CARBON_EXPLORER_INTERPRETER_ADDRESS_H_
|
|
|
|
#include <cstdint>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "common/ostream.h"
|
|
#include "explorer/interpreter/field_path.h"
|
|
#include "llvm/Support/Compiler.h"
|
|
|
|
namespace Carbon {
|
|
|
|
// An AllocationId identifies an _allocation_ produced by a Heap. An allocation
|
|
// is analogous to the C++ notion of a complete object: the `Value` in an
|
|
// allocation is not a sub-part of any other `Value`.
|
|
class AllocationId {
|
|
public:
|
|
AllocationId(const AllocationId&) = default;
|
|
auto operator=(const AllocationId&) -> AllocationId& = default;
|
|
|
|
// Prints a human-readable representation of *this to `out`.
|
|
//
|
|
// Currently that representation consists of an integer index.
|
|
void Print(llvm::raw_ostream& out) const {
|
|
out << "Allocation(" << index_ << ")";
|
|
}
|
|
|
|
private:
|
|
// The representation of AllocationId describes how to locate an object within
|
|
// a Heap, so its implementation details are tied to the implementation
|
|
// details of Heap.
|
|
friend class Heap;
|
|
|
|
explicit AllocationId(size_t index) : index_(index) {}
|
|
|
|
size_t index_;
|
|
};
|
|
|
|
// An Address represents a memory address in the Carbon virtual machine.
|
|
// Addresses are used to access values stored in a Heap. Unlike an
|
|
// AllocationId, an Address can refer to a sub-Value of some larger Value.
|
|
class Address {
|
|
public:
|
|
// Constructs an `Address` that refers to the value stored in `allocation`.
|
|
explicit Address(AllocationId allocation) : allocation_(allocation) {}
|
|
|
|
Address(const Address&) = default;
|
|
Address(Address&&) = default;
|
|
auto operator=(const Address&) -> Address& = default;
|
|
auto operator=(Address&&) -> Address& = default;
|
|
|
|
// Prints a human-readable representation of `a` to `out`.
|
|
//
|
|
// Currently, that representation consists of an AllocationId followed by an
|
|
// optional FieldPath specifying a particular field within that allocation.
|
|
void Print(llvm::raw_ostream& out) const {
|
|
out << allocation_ << 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(Member member) const -> Address {
|
|
Address result = *this;
|
|
result.field_path_.Append(member);
|
|
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;
|
|
|
|
AllocationId allocation_;
|
|
FieldPath field_path_;
|
|
};
|
|
|
|
} // namespace Carbon
|
|
|
|
#endif // CARBON_EXPLORER_INTERPRETER_ADDRESS_H_
|