SourceLocation.h revision 8f89652be7bb85bdac83c37fec85f20cdd2dfc83
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- SourceLocation.h - Compact identifier for Source Files -*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file defines the SourceLocation class. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_SOURCELOCATION_H 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_SOURCELOCATION_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 170827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include "llvm/Support/PointerLikeTypeTraits.h" 183632a35e811096da86d957c3e6ba0e73d75782f5Ted Kremenek#include <utility> 198f89652be7bb85bdac83c37fec85f20cdd2dfc83Argyrios Kyrtzidis#include <functional> 20ae50fa0a9e7217b043ed4ffe175af4b26dc90f34Chris Lattner#include <cassert> 219dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 229c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremeneknamespace llvm { 232b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner class MemoryBuffer; 24ae50fa0a9e7217b043ed4ffe175af4b26dc90f34Chris Lattner class raw_ostream; 25ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer class StringRef; 262b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner template <typename T> struct DenseMapInfo; 2706159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner template <typename T> struct isPodLike; 289c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek} 299c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 32a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekclass SourceManager; 331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 342b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// FileID - This is an opaque identifier used by SourceManager which refers to 352b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// a source file (MemoryBuffer) along with its #include path and #line data. 362b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// 372b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerclass FileID { 382b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// ID - Opaque identifier, 0 is "invalid". 392b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned ID; 402b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerpublic: 412b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID() : ID(0) {} 421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 432b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool isInvalid() const { return ID == 0; } 441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 452b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator==(const FileID &RHS) const { return ID == RHS.ID; } 462b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator<(const FileID &RHS) const { return ID < RHS.ID; } 472b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator<=(const FileID &RHS) const { return ID <= RHS.ID; } 482b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator!=(const FileID &RHS) const { return !(*this == RHS); } 492b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator>(const FileID &RHS) const { return RHS < *this; } 502b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator>=(const FileID &RHS) const { return RHS <= *this; } 511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 52de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static FileID getSentinel() { return get(~0U); } 532b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned getHashValue() const { return ID; } 541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 552b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerprivate: 562b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner friend class SourceManager; 57de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static FileID get(unsigned V) { 582b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID F; 592b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner F.ID = V; 602b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return F; 612b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 622b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned getOpaqueValue() const { return ID; } 632b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner}; 641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceLocation - This is a carefully crafted 32-bit identifier that encodes 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// a full include stack, line and column number information for a position in 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// an input translation unit. 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceLocation { 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned ID; 71bcc2a67e5180612417727cbdd8afd0f79fdf726dChris Lattner friend class SourceManager; 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 73de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner MacroIDBit = 1U << 31 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 759ebac5e0dab6f99717e3ff169c45048966146b2eChris Lattnerpublic: 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation() : ID(0) {} // 0 is an invalid FileID. 781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 79de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner bool isFileID() const { return (ID & MacroIDBit) == 0; } 80de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner bool isMacroID() const { return (ID & MacroIDBit) != 0; } 811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 82b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// isValid - Return true if this is a valid SourceLocation object. Invalid 83b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// SourceLocations are often used when events have no corresponding location 84b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// in the source (e.g. a diagnostic is required for a command line option). 85b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// 86b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isValid() const { return ID != 0; } 87b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isInvalid() const { return ID == 0; } 881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 896fda54c19321673965536b0a8f7236f635cf9730Chris Lattnerprivate: 90de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// getOffset - Return the index for SourceManager's SLocEntryTable table, 91de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// note that this is not an index *into* it though. 92de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned getOffset() const { 93de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return ID & ~MacroIDBit; 944d10ef18c32eae35be07e0d8d18b5ff485b4c5f9Chris Lattner } 956fda54c19321673965536b0a8f7236f635cf9730Chris Lattner 96de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static SourceLocation getFileLoc(unsigned ID) { 97de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert((ID & MacroIDBit) == 0 && "Ran out of source locations!"); 989dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation L; 99de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner L.ID = ID; 1009dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 1015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static SourceLocation getMacroLoc(unsigned ID) { 104de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert((ID & MacroIDBit) == 0 && "Ran out of source locations!"); 105d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation L; 106de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner L.ID = MacroIDBit | ID; 1079dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 1089dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1094d10ef18c32eae35be07e0d8d18b5ff485b4c5f9Chris Lattnerpublic: 1101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1119dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getFileLocWithOffset - Return a source location with the specified offset 1129dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// from this file SourceLocation. 113d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation getFileLocWithOffset(int Offset) const { 114de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert(((getOffset()+Offset) & MacroIDBit) == 0 && "invalid location"); 115de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation L; 116de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner L.ID = ID+Offset; 117de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return L; 1189dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawEncoding - When a SourceLocation itself cannot be used, this returns 1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an (opaque) 32-bit integer encoding for it. This should only be passed 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to SourceLocation::getFromRawEncoding, it should not be inspected 1235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// directly. 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getRawEncoding() const { return ID; } 1251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into 1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a real SourceLocation. 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer static SourceLocation getFromRawEncoding(unsigned Encoding) { 1295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation X; 1305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer X.ID = Encoding; 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 1325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 134dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin /// getPtrEncoding - When a SourceLocation itself cannot be used, this returns 135dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin /// an (opaque) pointer encoding for it. This should only be passed 136dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin /// to SourceLocation::getFromPtrEncoding, it should not be inspected 137dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin /// directly. 138dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin void* getPtrEncoding() const { 139dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin // Double cast to avoid a warning "cast to pointer from integer of different 140dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin // size". 141dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin return (void*)(uintptr_t)getRawEncoding(); 142dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin } 143dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin 144dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin /// getFromPtrEncoding - Turn a pointer encoding of a SourceLocation object 145dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin /// into a real SourceLocation. 146dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin static SourceLocation getFromPtrEncoding(void *Encoding) { 147dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin return getFromRawEncoding((unsigned)(uintptr_t)Encoding); 148dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin } 149dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin 150ae50fa0a9e7217b043ed4ffe175af4b26dc90f34Chris Lattner void print(llvm::raw_ostream &OS, const SourceManager &SM) const; 151b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner void dump(const SourceManager &SM) const; 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) { 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return LHS.getRawEncoding() == RHS.getRawEncoding(); 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) { 1595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return !(LHS == RHS); 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1626fda54c19321673965536b0a8f7236f635cf9730Chris Lattnerinline bool operator<(const SourceLocation &LHS, const SourceLocation &RHS) { 1636fda54c19321673965536b0a8f7236f635cf9730Chris Lattner return LHS.getRawEncoding() < RHS.getRawEncoding(); 1646fda54c19321673965536b0a8f7236f635cf9730Chris Lattner} 1655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceRange - a trival tuple used to represent a source range. 1675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceRange { 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation B; 1695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation E; 1705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(): B(SourceLocation()), E(SourceLocation()) {} 1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation loc) : B(loc), E(loc) {} 1735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {} 1741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 175311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getBegin() const { return B; } 176311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getEnd() const { return E; } 1771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 178e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setBegin(SourceLocation b) { B = b; } 179e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setEnd(SourceLocation e) { E = e; } 1801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isValid() const { return B.isValid() && E.isValid(); } 182782f2f52b78d8ca785110398a7f7b56b830b9ac7Ted Kremenek bool isInvalid() const { return !isValid(); } 1831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 184a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek bool operator==(const SourceRange &X) const { 185a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek return B == X.B && E == X.E; 186a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek } 1871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 188a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek bool operator!=(const SourceRange &X) const { 189a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek return B != X.B || E != X.E; 190a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek } 19119a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek}; 1920a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1930a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner/// CharSourceRange - This class represents a character granular source range. 1940a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner/// The underlying SourceRange can either specify the starting/ending character 1950a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner/// of the range, or it can specify the start or the range and the start of the 1960a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner/// last token of the range (a "token range"). In the token range case, the 1970a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner/// size of the last token must be measured to determine the actual end of the 1980a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner/// range. 1990a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattnerclass CharSourceRange { 2000a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner SourceRange Range; 2010a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner bool IsTokenRange; 2020a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattnerpublic: 2030a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange() : IsTokenRange(false) {} 2040a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange(SourceRange R, bool ITR) : Range(R),IsTokenRange(ITR){} 2050a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 2060a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static CharSourceRange getTokenRange(SourceRange R) { 2070a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange Result; 2080a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner Result.Range = R; 2090a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner Result.IsTokenRange = true; 2100a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return Result; 2110a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 2120a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 2130a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static CharSourceRange getCharRange(SourceRange R) { 2140a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange Result; 2150a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner Result.Range = R; 2160a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner Result.IsTokenRange = false; 2170a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return Result; 2180a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 2190a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 2200a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static CharSourceRange getTokenRange(SourceLocation B, SourceLocation E) { 2210a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return getTokenRange(SourceRange(B, E)); 2220a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 2230a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static CharSourceRange getCharRange(SourceLocation B, SourceLocation E) { 2240a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return getCharRange(SourceRange(B, E)); 2250a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 2260a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 2270a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner /// isTokenRange - Return true if the end of this range specifies the start of 2280a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner /// the last token. Return false if the end of this range specifies the last 2290a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner /// character in the range. 2300a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner bool isTokenRange() const { return IsTokenRange; } 2310a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 2320a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner SourceLocation getBegin() const { return Range.getBegin(); } 2330a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner SourceLocation getEnd() const { return Range.getEnd(); } 2340a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const SourceRange &getAsRange() const { return Range; } 2350a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 2360a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner void setBegin(SourceLocation b) { Range.setBegin(b); } 2370a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner void setEnd(SourceLocation e) { Range.setEnd(e); } 2380a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 2390a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner bool isValid() const { return Range.isValid(); } 2400a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner bool isInvalid() const { return !isValid(); } 2410a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner}; 2421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 243a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner/// FullSourceLoc - A SourceLocation and its associated SourceManager. Useful 244a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner/// for argument passing to functions that expect both objects. 245a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattnerclass FullSourceLoc : public SourceLocation { 2465c5db4e94bd1243ba92563acba51ba66afa94917Chris Lattner const SourceManager *SrcMgr; 247a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekpublic: 2483632a35e811096da86d957c3e6ba0e73d75782f5Ted Kremenek /// Creates a FullSourceLoc where isValid() returns false. 2495c5db4e94bd1243ba92563acba51ba66afa94917Chris Lattner explicit FullSourceLoc() : SrcMgr(0) {} 250a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 2515c5db4e94bd1243ba92563acba51ba66afa94917Chris Lattner explicit FullSourceLoc(SourceLocation Loc, const SourceManager &SM) 252a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner : SourceLocation(Loc), SrcMgr(&SM) {} 2531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 254b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner const SourceManager &getManager() const { 255b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner assert(SrcMgr && "SourceManager is NULL."); 256a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek return *SrcMgr; 257a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek } 2581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2593b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner FileID getFileID() const; 2601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 261f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner FullSourceLoc getInstantiationLoc() const; 262df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner FullSourceLoc getSpellingLoc() const; 2639c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 26464e462dff03492c586be0349ec6aa3ad5cd92720Douglas Gregor unsigned getInstantiationLineNumber(bool *Invalid = 0) const; 26564e462dff03492c586be0349ec6aa3ad5cd92720Douglas Gregor unsigned getInstantiationColumnNumber(bool *Invalid = 0) const; 2669c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 26764e462dff03492c586be0349ec6aa3ad5cd92720Douglas Gregor unsigned getSpellingLineNumber(bool *Invalid = 0) const; 26864e462dff03492c586be0349ec6aa3ad5cd92720Douglas Gregor unsigned getSpellingColumnNumber(bool *Invalid = 0) const; 2695c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner 270a543016fe07030f695d6d56fd22c8c8da617e0d7Douglas Gregor const char *getCharacterData(bool *Invalid = 0) const; 2711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 272aae58b0c3efb5fa9f97a3e4b1c1a2d31077efe5bDouglas Gregor const llvm::MemoryBuffer* getBuffer(bool *Invalid = 0) const; 2731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 274ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// getBufferData - Return a StringRef to the source buffer data for the 275ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// specified FileID. 276aae58b0c3efb5fa9f97a3e4b1c1a2d31077efe5bDouglas Gregor llvm::StringRef getBufferData(bool *Invalid = 0) const; 2771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 278321abd4583dc02a254489132c5ccbe125d18ce4fTed Kremenek /// getDecomposedLoc - Decompose the specified location into a raw FileID + 279321abd4583dc02a254489132c5ccbe125d18ce4fTed Kremenek /// Offset pair. The first element is the FileID, the second is the 280321abd4583dc02a254489132c5ccbe125d18ce4fTed Kremenek /// offset from the start of the buffer of the location. 281321abd4583dc02a254489132c5ccbe125d18ce4fTed Kremenek std::pair<FileID, unsigned> getDecomposedLoc() const; 282321abd4583dc02a254489132c5ccbe125d18ce4fTed Kremenek 2837bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber bool isInSystemHeader() const; 2841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2850827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Determines the order of 2 source locations in the translation unit. 2860827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 2870827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \returns true if this source location comes before 'Loc', false otherwise. 2880827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool isBeforeInTranslationUnitThan(SourceLocation Loc) const; 2890827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2900827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Determines the order of 2 source locations in the translation unit. 2910827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 2920827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \returns true if this source location comes before 'Loc', false otherwise. 2930827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool isBeforeInTranslationUnitThan(FullSourceLoc Loc) const { 2940827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis assert(Loc.isValid()); 2950827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis assert(SrcMgr == Loc.SrcMgr && "Loc comes from another SourceManager!"); 2960827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return isBeforeInTranslationUnitThan((SourceLocation)Loc); 2970827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2980827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2998f89652be7bb85bdac83c37fec85f20cdd2dfc83Argyrios Kyrtzidis /// \brief Comparison function class, useful for sorting FullSourceLocs. 3008f89652be7bb85bdac83c37fec85f20cdd2dfc83Argyrios Kyrtzidis struct BeforeThanCompare : public std::binary_function<FullSourceLoc, 3018f89652be7bb85bdac83c37fec85f20cdd2dfc83Argyrios Kyrtzidis FullSourceLoc, bool> { 3028f89652be7bb85bdac83c37fec85f20cdd2dfc83Argyrios Kyrtzidis bool operator()(const FullSourceLoc& lhs, const FullSourceLoc& rhs) const { 3038f89652be7bb85bdac83c37fec85f20cdd2dfc83Argyrios Kyrtzidis return lhs.isBeforeInTranslationUnitThan(rhs); 3048f89652be7bb85bdac83c37fec85f20cdd2dfc83Argyrios Kyrtzidis } 3058f89652be7bb85bdac83c37fec85f20cdd2dfc83Argyrios Kyrtzidis }; 3068f89652be7bb85bdac83c37fec85f20cdd2dfc83Argyrios Kyrtzidis 3075c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner /// Prints information about this FullSourceLoc to stderr. Useful for 3085c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner /// debugging. 309b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner void dump() const { SourceLocation::dump(*SrcMgr); } 310a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 3111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump friend inline bool 3120b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 3130b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor return LHS.getRawEncoding() == RHS.getRawEncoding() && 3140b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor LHS.SrcMgr == RHS.SrcMgr; 3150b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor } 316a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner 3171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump friend inline bool 3180b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 3190b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor return !(LHS == RHS); 3200b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor } 3210b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor 3220b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor}; 3231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 324b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// PresumedLoc - This class represents an unpacked "presumed" location which 325b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// can be presented to the user. A 'presumed' location can be modified by 326b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// #line and GNU line marker directives and is always the instantiation point 327b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// of a normal location. 328b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// 329b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// You can get a PresumedLoc from a SourceLocation with SourceManager. 330b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattnerclass PresumedLoc { 331b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner const char *Filename; 332b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner unsigned Line, Col; 333b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner SourceLocation IncludeLoc; 334b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattnerpublic: 335b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner PresumedLoc() : Filename(0) {} 336b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner PresumedLoc(const char *FN, unsigned Ln, unsigned Co, SourceLocation IL) 337b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner : Filename(FN), Line(Ln), Col(Co), IncludeLoc(IL) { 338b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner } 3391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 340b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// isInvalid - Return true if this object is invalid or uninitialized. This 341b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// occurs when created with invalid source locations or when walking off 342b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// the top of a #include stack. 343b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner bool isInvalid() const { return Filename == 0; } 344b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner bool isValid() const { return Filename != 0; } 3451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 346b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getFilename - Return the presumed filename of this location. This can be 347b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// affected by #line etc. 348b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner const char *getFilename() const { return Filename; } 349b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 350b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getLine - Return the presumed line number of this location. This can be 351b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// affected by #line etc. 352b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner unsigned getLine() const { return Line; } 3531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 354b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getColumn - Return the presumed column number of this location. This can 355b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// not be affected by #line, but is packaged here for convenience. 356b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner unsigned getColumn() const { return Col; } 357b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 358b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getIncludeLoc - Return the presumed include location of this location. 359b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// This can be affected by GNU linemarker directives. 360b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner SourceLocation getIncludeLoc() const { return IncludeLoc; } 361b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner}; 362b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 364beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek} // end namespace clang 36519a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 3662b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnernamespace llvm { 3672b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// Define DenseMapInfo so that FileID's can be used as keys in DenseMap and 3682b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// DenseSets. 3692b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner template <> 3702b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner struct DenseMapInfo<clang::FileID> { 3712b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static inline clang::FileID getEmptyKey() { 3722b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return clang::FileID(); 3732b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 3742b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static inline clang::FileID getTombstoneKey() { 3751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return clang::FileID::getSentinel(); 3762b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 3771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3782b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static unsigned getHashValue(clang::FileID S) { 3792b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return S.getHashValue(); 3802b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 3811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3822b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static bool isEqual(clang::FileID LHS, clang::FileID RHS) { 3832b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return LHS == RHS; 3842b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 3852b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner }; 38606159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner 38706159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner template <> 38806159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner struct isPodLike<clang::SourceLocation> { static const bool value = true; }; 38906159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner template <> 39006159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner struct isPodLike<clang::FileID> { static const bool value = true; }; 3911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3920827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // Teach SmallPtrSet how to handle SourceLocation. 3930827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis template<> 3940827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis class PointerLikeTypeTraits<clang::SourceLocation> { 3950827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis public: 3960827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis static inline void *getAsVoidPointer(clang::SourceLocation L) { 397dec0984fce504a39a7f085774fb67cfd9957be58Jeffrey Yasskin return L.getPtrEncoding(); 3980827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 3990827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis static inline clang::SourceLocation getFromVoidPointer(void *P) { 4000827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return clang::SourceLocation::getFromRawEncoding((unsigned)(uintptr_t)P); 4010827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 4020827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis enum { NumLowBitsAvailable = 0 }; 4030827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis }; 4040827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 4052b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner} // end namespace llvm 4062b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 4075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 408