blob: 6b3430b365124450757ddd358ce2fb2828a53c80 [file] [log] [blame]
//===--- Located.h - Source Location and Associated Value ----------*- C++ -*-===//
// This source file is part of the open source project
// Copyright (c) 2019 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
// See for license information
// See for the list of Swift project authors
// Provides a currency data type Located<T> that should be used instead
// of std::pair<T, SourceLoc>.
#include "swift/Basic/Debug.h"
#include "swift/Basic/LLVM.h"
#include "swift/Basic/SourceLoc.h"
namespace swift {
/// A currency type for keeping track of items which were found in the source code.
/// Several parts of the compiler need to keep track of a `SourceLoc` corresponding
/// to an item, in case they need to report some diagnostics later. For example,
/// the ClangImporter needs to keep track of where imports were originally written.
/// Located makes it easy to do so while making the code more readable, compared to
/// using `std::pair`.
template <typename T>
struct Located {
/// The main item whose source location is being tracked.
T Item;
/// The original source location from which the item was parsed.
SourceLoc Loc;
Located() : Item(), Loc() {}
Located(T Item, SourceLoc loc) : Item(Item), Loc(loc) {}
void dump(raw_ostream &os) const;
template <typename T>
bool operator ==(const Located<T> &lhs, const Located<T> &rhs) {
return lhs.Item == rhs.Item && lhs.Loc == rhs.Loc;
} // end namespace swift
namespace llvm {
template <typename T> struct DenseMapInfo;
template<typename T>
struct DenseMapInfo<swift::Located<T>> {
static inline swift::Located<T> getEmptyKey() {
return swift::Located<T>(DenseMapInfo<T>::getEmptyKey(),
static inline swift::Located<T> getTombstoneKey() {
return swift::Located<T>(DenseMapInfo<T>::getTombstoneKey(),
static unsigned getHashValue(const swift::Located<T> &LocatedVal) {
return combineHashValue(DenseMapInfo<T>::getHashValue(LocatedVal.Item),
static bool isEqual(const swift::Located<T> &LHS, const swift::Located<T> &RHS) {
return DenseMapInfo<T>::isEqual(LHS.Item, RHS.Item) &&
DenseMapInfo<T>::isEqual(LHS.Loc, RHS.Loc);
} // namespace llvm