SourceLocation.h revision 5c5db4e94bd1243ba92563acba51ba66afa94917
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 173632a35e811096da86d957c3e6ba0e73d75782f5Ted Kremenek#include <utility> 18ae50fa0a9e7217b043ed4ffe175af4b26dc90f34Chris Lattner#include <cassert> 199dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 209c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremeneknamespace llvm { 212b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner class MemoryBuffer; 22ae50fa0a9e7217b043ed4ffe175af4b26dc90f34Chris Lattner class raw_ostream; 23ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer class StringRef; 242b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner template <typename T> struct DenseMapInfo; 2506159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner template <typename T> struct isPodLike; 269c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek} 279c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekclass SourceManager; 311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 322b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// FileID - This is an opaque identifier used by SourceManager which refers to 332b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// a source file (MemoryBuffer) along with its #include path and #line data. 342b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// 352b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerclass FileID { 362b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// ID - Opaque identifier, 0 is "invalid". 372b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned ID; 382b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerpublic: 392b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID() : ID(0) {} 401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 412b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool isInvalid() const { return ID == 0; } 421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 432b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator==(const FileID &RHS) const { return ID == RHS.ID; } 442b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator<(const FileID &RHS) const { return ID < RHS.ID; } 452b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator<=(const FileID &RHS) const { return ID <= RHS.ID; } 462b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator!=(const FileID &RHS) const { return !(*this == RHS); } 472b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator>(const FileID &RHS) const { return RHS < *this; } 482b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator>=(const FileID &RHS) const { return RHS <= *this; } 491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 50de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static FileID getSentinel() { return get(~0U); } 512b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned getHashValue() const { return ID; } 521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 532b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerprivate: 542b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner friend class SourceManager; 55de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static FileID get(unsigned V) { 562b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID F; 572b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner F.ID = V; 582b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return F; 592b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 602b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned getOpaqueValue() const { return ID; } 612b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner}; 621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceLocation - This is a carefully crafted 32-bit identifier that encodes 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// a full include stack, line and column number information for a position in 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// an input translation unit. 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceLocation { 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned ID; 69bcc2a67e5180612417727cbdd8afd0f79fdf726dChris Lattner friend class SourceManager; 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 71de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner MacroIDBit = 1U << 31 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 739ebac5e0dab6f99717e3ff169c45048966146b2eChris Lattnerpublic: 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation() : ID(0) {} // 0 is an invalid FileID. 761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 77de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner bool isFileID() const { return (ID & MacroIDBit) == 0; } 78de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner bool isMacroID() const { return (ID & MacroIDBit) != 0; } 791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// isValid - Return true if this is a valid SourceLocation object. Invalid 81b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// SourceLocations are often used when events have no corresponding location 82b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// in the source (e.g. a diagnostic is required for a command line option). 83b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// 84b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isValid() const { return ID != 0; } 85b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isInvalid() const { return ID == 0; } 861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 876fda54c19321673965536b0a8f7236f635cf9730Chris Lattnerprivate: 88de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// getOffset - Return the index for SourceManager's SLocEntryTable table, 89de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// note that this is not an index *into* it though. 90de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned getOffset() const { 91de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return ID & ~MacroIDBit; 924d10ef18c32eae35be07e0d8d18b5ff485b4c5f9Chris Lattner } 936fda54c19321673965536b0a8f7236f635cf9730Chris Lattner 94de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static SourceLocation getFileLoc(unsigned ID) { 95de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert((ID & MacroIDBit) == 0 && "Ran out of source locations!"); 969dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation L; 97de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner L.ID = ID; 989dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 101de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static SourceLocation getMacroLoc(unsigned ID) { 102de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert((ID & MacroIDBit) == 0 && "Ran out of source locations!"); 103d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation L; 104de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner L.ID = MacroIDBit | ID; 1059dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 1069dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1074d10ef18c32eae35be07e0d8d18b5ff485b4c5f9Chris Lattnerpublic: 1081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1099dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getFileLocWithOffset - Return a source location with the specified offset 1109dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// from this file SourceLocation. 111d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation getFileLocWithOffset(int Offset) const { 112de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert(((getOffset()+Offset) & MacroIDBit) == 0 && "invalid location"); 113de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation L; 114de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner L.ID = ID+Offset; 115de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return L; 1169dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawEncoding - When a SourceLocation itself cannot be used, this returns 1195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an (opaque) 32-bit integer encoding for it. This should only be passed 1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to SourceLocation::getFromRawEncoding, it should not be inspected 1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// directly. 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getRawEncoding() const { return ID; } 1231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into 1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a real SourceLocation. 1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer static SourceLocation getFromRawEncoding(unsigned Encoding) { 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation X; 1295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer X.ID = Encoding; 1305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 133ae50fa0a9e7217b043ed4ffe175af4b26dc90f34Chris Lattner void print(llvm::raw_ostream &OS, const SourceManager &SM) const; 134b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner void dump(const SourceManager &SM) const; 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) { 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return LHS.getRawEncoding() == RHS.getRawEncoding(); 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) { 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return !(LHS == RHS); 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1456fda54c19321673965536b0a8f7236f635cf9730Chris Lattnerinline bool operator<(const SourceLocation &LHS, const SourceLocation &RHS) { 1466fda54c19321673965536b0a8f7236f635cf9730Chris Lattner return LHS.getRawEncoding() < RHS.getRawEncoding(); 1476fda54c19321673965536b0a8f7236f635cf9730Chris Lattner} 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceRange - a trival tuple used to represent a source range. 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceRange { 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation B; 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation E; 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(): B(SourceLocation()), E(SourceLocation()) {} 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation loc) : B(loc), E(loc) {} 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {} 1571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 158311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getBegin() const { return B; } 159311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getEnd() const { return E; } 1601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 161e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setBegin(SourceLocation b) { B = b; } 162e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setEnd(SourceLocation e) { E = e; } 1631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isValid() const { return B.isValid() && E.isValid(); } 165782f2f52b78d8ca785110398a7f7b56b830b9ac7Ted Kremenek bool isInvalid() const { return !isValid(); } 1661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 167a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek bool operator==(const SourceRange &X) const { 168a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek return B == X.B && E == X.E; 169a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek } 1701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 171a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek bool operator!=(const SourceRange &X) const { 172a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek return B != X.B || E != X.E; 173a898283deb689b2454f3a966ef1cbf81bcb3e3e4Ted Kremenek } 17419a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek}; 1751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 176a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner/// FullSourceLoc - A SourceLocation and its associated SourceManager. Useful 177a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner/// for argument passing to functions that expect both objects. 178a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattnerclass FullSourceLoc : public SourceLocation { 1795c5db4e94bd1243ba92563acba51ba66afa94917Chris Lattner const SourceManager *SrcMgr; 180a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekpublic: 1813632a35e811096da86d957c3e6ba0e73d75782f5Ted Kremenek /// Creates a FullSourceLoc where isValid() returns false. 1825c5db4e94bd1243ba92563acba51ba66afa94917Chris Lattner explicit FullSourceLoc() : SrcMgr(0) {} 183a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 1845c5db4e94bd1243ba92563acba51ba66afa94917Chris Lattner explicit FullSourceLoc(SourceLocation Loc, const SourceManager &SM) 185a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner : SourceLocation(Loc), SrcMgr(&SM) {} 1861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 187b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner const SourceManager &getManager() const { 188b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner assert(SrcMgr && "SourceManager is NULL."); 189a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek return *SrcMgr; 190a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek } 1911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1923b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner FileID getFileID() const; 1931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 194f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner FullSourceLoc getInstantiationLoc() const; 195df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner FullSourceLoc getSpellingLoc() const; 1969c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 19764e462dff03492c586be0349ec6aa3ad5cd92720Douglas Gregor unsigned getInstantiationLineNumber(bool *Invalid = 0) const; 19864e462dff03492c586be0349ec6aa3ad5cd92720Douglas Gregor unsigned getInstantiationColumnNumber(bool *Invalid = 0) const; 1999c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 20064e462dff03492c586be0349ec6aa3ad5cd92720Douglas Gregor unsigned getSpellingLineNumber(bool *Invalid = 0) const; 20164e462dff03492c586be0349ec6aa3ad5cd92720Douglas Gregor unsigned getSpellingColumnNumber(bool *Invalid = 0) const; 2025c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner 203a543016fe07030f695d6d56fd22c8c8da617e0d7Douglas Gregor const char *getCharacterData(bool *Invalid = 0) const; 2041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 205aae58b0c3efb5fa9f97a3e4b1c1a2d31077efe5bDouglas Gregor const llvm::MemoryBuffer* getBuffer(bool *Invalid = 0) const; 2061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 207ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// getBufferData - Return a StringRef to the source buffer data for the 208ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// specified FileID. 209aae58b0c3efb5fa9f97a3e4b1c1a2d31077efe5bDouglas Gregor llvm::StringRef getBufferData(bool *Invalid = 0) const; 2101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 211321abd4583dc02a254489132c5ccbe125d18ce4fTed Kremenek /// getDecomposedLoc - Decompose the specified location into a raw FileID + 212321abd4583dc02a254489132c5ccbe125d18ce4fTed Kremenek /// Offset pair. The first element is the FileID, the second is the 213321abd4583dc02a254489132c5ccbe125d18ce4fTed Kremenek /// offset from the start of the buffer of the location. 214321abd4583dc02a254489132c5ccbe125d18ce4fTed Kremenek std::pair<FileID, unsigned> getDecomposedLoc() const; 215321abd4583dc02a254489132c5ccbe125d18ce4fTed Kremenek 2167bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber bool isInSystemHeader() const; 2171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2185c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner /// Prints information about this FullSourceLoc to stderr. Useful for 2195c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner /// debugging. 220b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner void dump() const { SourceLocation::dump(*SrcMgr); } 221a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 2221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump friend inline bool 2230b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 2240b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor return LHS.getRawEncoding() == RHS.getRawEncoding() && 2250b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor LHS.SrcMgr == RHS.SrcMgr; 2260b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor } 227a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner 2281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump friend inline bool 2290b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 2300b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor return !(LHS == RHS); 2310b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor } 2320b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor 2330b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor}; 2341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 235b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// PresumedLoc - This class represents an unpacked "presumed" location which 236b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// can be presented to the user. A 'presumed' location can be modified by 237b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// #line and GNU line marker directives and is always the instantiation point 238b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// of a normal location. 239b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// 240b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// You can get a PresumedLoc from a SourceLocation with SourceManager. 241b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattnerclass PresumedLoc { 242b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner const char *Filename; 243b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner unsigned Line, Col; 244b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner SourceLocation IncludeLoc; 245b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattnerpublic: 246b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner PresumedLoc() : Filename(0) {} 247b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner PresumedLoc(const char *FN, unsigned Ln, unsigned Co, SourceLocation IL) 248b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner : Filename(FN), Line(Ln), Col(Co), IncludeLoc(IL) { 249b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner } 2501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 251b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// isInvalid - Return true if this object is invalid or uninitialized. This 252b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// occurs when created with invalid source locations or when walking off 253b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// the top of a #include stack. 254b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner bool isInvalid() const { return Filename == 0; } 255b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner bool isValid() const { return Filename != 0; } 2561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 257b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getFilename - Return the presumed filename of this location. This can be 258b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// affected by #line etc. 259b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner const char *getFilename() const { return Filename; } 260b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 261b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getLine - Return the presumed line number of this location. This can be 262b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// affected by #line etc. 263b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner unsigned getLine() const { return Line; } 2641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 265b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getColumn - Return the presumed column number of this location. This can 266b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// not be affected by #line, but is packaged here for convenience. 267b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner unsigned getColumn() const { return Col; } 268b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 269b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getIncludeLoc - Return the presumed include location of this location. 270b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// This can be affected by GNU linemarker directives. 271b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner SourceLocation getIncludeLoc() const { return IncludeLoc; } 272b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner}; 273b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 2741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 275beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek} // end namespace clang 27619a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 2772b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnernamespace llvm { 2782b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// Define DenseMapInfo so that FileID's can be used as keys in DenseMap and 2792b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// DenseSets. 2802b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner template <> 2812b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner struct DenseMapInfo<clang::FileID> { 2822b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static inline clang::FileID getEmptyKey() { 2832b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return clang::FileID(); 2842b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 2852b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static inline clang::FileID getTombstoneKey() { 2861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return clang::FileID::getSentinel(); 2872b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 2881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2892b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static unsigned getHashValue(clang::FileID S) { 2902b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return S.getHashValue(); 2912b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 2921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2932b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static bool isEqual(clang::FileID LHS, clang::FileID RHS) { 2942b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return LHS == RHS; 2952b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 2962b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner }; 29706159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner 29806159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner template <> 29906159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner struct isPodLike<clang::SourceLocation> { static const bool value = true; }; 30006159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner template <> 30106159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner struct isPodLike<clang::FileID> { static const bool value = true; }; 3021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3032b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner} // end namespace llvm 3042b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 3055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 306