SourceLocation.h revision b9c3f966b103f7cfe8e5e60007c4c8b38f7298eb
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 179dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner#include <cassert> 180a449eed1dd2439b4b9c0a6291084816eab390c1Ted Kremenek#include "llvm/Bitcode/SerializationFwd.h" 199dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 209c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremeneknamespace llvm { 212b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner class MemoryBuffer; 222b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner template <typename T> struct DenseMapInfo; 239c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek} 249c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 26a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 27a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekclass SourceManager; 289c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenekclass FileEntry; 292b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 302b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// FileID - This is an opaque identifier used by SourceManager which refers to 312b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// a source file (MemoryBuffer) along with its #include path and #line data. 322b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// 332b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerclass FileID { 342b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// ID - Opaque identifier, 0 is "invalid". 352b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned ID; 362b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerpublic: 372b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID() : ID(0) {} 382b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 392b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool isInvalid() const { return ID == 0; } 402b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 412b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator==(const FileID &RHS) const { return ID == RHS.ID; } 422b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator<(const FileID &RHS) const { return ID < RHS.ID; } 432b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator<=(const FileID &RHS) const { return ID <= RHS.ID; } 442b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator!=(const FileID &RHS) const { return !(*this == RHS); } 452b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator>(const FileID &RHS) const { return RHS < *this; } 462b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator>=(const FileID &RHS) const { return RHS <= *this; } 472b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 48de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static FileID getSentinel() { return get(~0U); } 492b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned getHashValue() const { return ID; } 502b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 512b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerprivate: 522b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner friend class SourceManager; 53de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static FileID get(unsigned V) { 542b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID F; 552b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner F.ID = V; 562b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return F; 572b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 582b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned getOpaqueValue() const { return ID; } 592b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner}; 602b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceLocation - This is a carefully crafted 32-bit identifier that encodes 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// a full include stack, line and column number information for a position in 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// an input translation unit. 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceLocation { 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned ID; 67bcc2a67e5180612417727cbdd8afd0f79fdf726dChris Lattner friend class SourceManager; 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 69de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner MacroIDBit = 1U << 31 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 719ebac5e0dab6f99717e3ff169c45048966146b2eChris Lattnerpublic: 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation() : ID(0) {} // 0 is an invalid FileID. 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 75de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner bool isFileID() const { return (ID & MacroIDBit) == 0; } 76de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner bool isMacroID() const { return (ID & MacroIDBit) != 0; } 779dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 78b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// isValid - Return true if this is a valid SourceLocation object. Invalid 79b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// SourceLocations are often used when events have no corresponding location 80b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// in the source (e.g. a diagnostic is required for a command line option). 81b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// 82b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isValid() const { return ID != 0; } 83b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isInvalid() const { return ID == 0; } 84b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 856fda54c19321673965536b0a8f7236f635cf9730Chris Lattnerprivate: 86de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// getOffset - Return the index for SourceManager's SLocEntryTable table, 87de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// note that this is not an index *into* it though. 88de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned getOffset() const { 89de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return ID & ~MacroIDBit; 904d10ef18c32eae35be07e0d8d18b5ff485b4c5f9Chris Lattner } 916fda54c19321673965536b0a8f7236f635cf9730Chris Lattner 92de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static SourceLocation getFileLoc(unsigned ID) { 93de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert((ID & MacroIDBit) == 0 && "Ran out of source locations!"); 949dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation L; 95de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner L.ID = ID; 969dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 99de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static SourceLocation getMacroLoc(unsigned ID) { 100de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert((ID & MacroIDBit) == 0 && "Ran out of source locations!"); 101d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation L; 102de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner L.ID = MacroIDBit | ID; 1039dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 1049dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1054d10ef18c32eae35be07e0d8d18b5ff485b4c5f9Chris Lattnerpublic: 1069dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1079dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getFileLocWithOffset - Return a source location with the specified offset 1089dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// from this file SourceLocation. 109d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation getFileLocWithOffset(int Offset) const { 110de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert(((getOffset()+Offset) & MacroIDBit) == 0 && "invalid location"); 111de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation L; 112de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner L.ID = ID+Offset; 113de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return L; 1149dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawEncoding - When a SourceLocation itself cannot be used, this returns 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an (opaque) 32-bit integer encoding for it. This should only be passed 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to SourceLocation::getFromRawEncoding, it should not be inspected 1195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// directly. 1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getRawEncoding() const { return ID; } 1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 122cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner 1235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a real SourceLocation. 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer static SourceLocation getFromRawEncoding(unsigned Encoding) { 1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation X; 1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer X.ID = Encoding; 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 1295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 130beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek 131beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// Emit - Emit this SourceLocation object to Bitcode. 132beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek void Emit(llvm::Serializer& S) const; 133beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek 134beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// ReadVal - Read a SourceLocation object from Bitcode. 135beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek static SourceLocation ReadVal(llvm::Deserializer& D); 136b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 137b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner void dump(const SourceManager &SM) const; 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) { 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return LHS.getRawEncoding() == RHS.getRawEncoding(); 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) { 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return !(LHS == RHS); 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1476fda54c19321673965536b0a8f7236f635cf9730Chris Lattner 1486fda54c19321673965536b0a8f7236f635cf9730Chris Lattnerinline bool operator<(const SourceLocation &LHS, const SourceLocation &RHS) { 1496fda54c19321673965536b0a8f7236f635cf9730Chris Lattner return LHS.getRawEncoding() < RHS.getRawEncoding(); 1506fda54c19321673965536b0a8f7236f635cf9730Chris Lattner} 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceRange - a trival tuple used to represent a source range. 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceRange { 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation B; 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation E; 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(): B(SourceLocation()), E(SourceLocation()) {} 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation loc) : B(loc), E(loc) {} 1595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {} 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 161311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getBegin() const { return B; } 162311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getEnd() const { return E; } 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 164e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setBegin(SourceLocation b) { B = b; } 165e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setEnd(SourceLocation e) { E = e; } 166e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner 1675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isValid() const { return B.isValid() && E.isValid(); } 16819a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 169beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// Emit - Emit this SourceRange object to Bitcode. 170beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek void Emit(llvm::Serializer& S) const; 17119a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 172beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// ReadVal - Read a SourceRange object from Bitcode. 173beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek static SourceRange ReadVal(llvm::Deserializer& D); 17419a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek}; 17519a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 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 { 1799c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek SourceManager* SrcMgr; 180a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekpublic: 1811b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek // Creates a FullSourceLoc where isValid() returns false. 182a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner explicit FullSourceLoc() : SrcMgr((SourceManager*) 0) {} 183a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 184a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner explicit FullSourceLoc(SourceLocation Loc, SourceManager &SM) 185a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner : SourceLocation(Loc), SrcMgr(&SM) {} 1861b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek 187b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner SourceManager &getManager() { 188b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner assert(SrcMgr && "SourceManager is NULL."); 1899c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek return *SrcMgr; 1909c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek } 191a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 192b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner const SourceManager &getManager() const { 193b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner assert(SrcMgr && "SourceManager is NULL."); 194a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek return *SrcMgr; 195a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek } 1969c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 1973b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner FileID getFileID() const; 1983b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner 199f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner FullSourceLoc getInstantiationLoc() const; 200df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner FullSourceLoc getSpellingLoc() const; 2019c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2021758b07ef7c554b06c48a43df2edaba85e918031Ted Kremenek unsigned getLineNumber() const; 2031758b07ef7c554b06c48a43df2edaba85e918031Ted Kremenek unsigned getColumnNumber() const; 2041758b07ef7c554b06c48a43df2edaba85e918031Ted Kremenek 205f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner unsigned getInstantiationLineNumber() const; 206f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner unsigned getInstantiationColumnNumber() const; 2079c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 208df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner unsigned getSpellingLineNumber() const; 209df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner unsigned getSpellingColumnNumber() const; 2105c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner 2119c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek const char *getCharacterData() const; 2129c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2139c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek const llvm::MemoryBuffer* getBuffer() const; 2149c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2157bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber bool isInSystemHeader() const; 2169c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2175c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner /// Prints information about this FullSourceLoc to stderr. Useful for 2185c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner /// debugging. 219b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner void dump() const { SourceLocation::dump(*SrcMgr); } 220a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 2210b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor friend inline bool 2220b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 2230b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor return LHS.getRawEncoding() == RHS.getRawEncoding() && 2240b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor LHS.SrcMgr == RHS.SrcMgr; 2250b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor } 226a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner 2270b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor friend inline bool 2280b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 2290b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor return !(LHS == RHS); 2300b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor } 2310b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor 2320b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor}; 233b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 234b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// PresumedLoc - This class represents an unpacked "presumed" location which 235b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// can be presented to the user. A 'presumed' location can be modified by 236b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// #line and GNU line marker directives and is always the instantiation point 237b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// of a normal location. 238b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// 239b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner/// You can get a PresumedLoc from a SourceLocation with SourceManager. 240b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattnerclass PresumedLoc { 241b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner const char *Filename; 242b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner unsigned Line, Col; 243b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner SourceLocation IncludeLoc; 244b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattnerpublic: 245b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner PresumedLoc() : Filename(0) {} 246b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner PresumedLoc(const char *FN, unsigned Ln, unsigned Co, SourceLocation IL) 247b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner : Filename(FN), Line(Ln), Col(Co), IncludeLoc(IL) { 248b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner } 249b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 250b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// isInvalid - Return true if this object is invalid or uninitialized. This 251b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// occurs when created with invalid source locations or when walking off 252b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// the top of a #include stack. 253b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner bool isInvalid() const { return Filename == 0; } 254b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner bool isValid() const { return Filename != 0; } 255b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 256b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getFilename - Return the presumed filename of this location. This can be 257b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// affected by #line etc. 258b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner const char *getFilename() const { return Filename; } 259b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 260b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getLine - Return the presumed line number of this location. This can be 261b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// affected by #line etc. 262b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner unsigned getLine() const { return Line; } 263b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 264b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getColumn - Return the presumed column number of this location. This can 265b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// not be affected by #line, but is packaged here for convenience. 266b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner unsigned getColumn() const { return Col; } 267b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 268b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getIncludeLoc - Return the presumed include location of this location. 269b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// This can be affected by GNU linemarker directives. 270b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner SourceLocation getIncludeLoc() const { return IncludeLoc; } 271b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner}; 272b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 273b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner 274beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek} // end namespace clang 27519a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 2762b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnernamespace llvm { 2772b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// Define DenseMapInfo so that FileID's can be used as keys in DenseMap and 2782b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// DenseSets. 2792b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner template <> 2802b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner struct DenseMapInfo<clang::FileID> { 2812b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static inline clang::FileID getEmptyKey() { 2822b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return clang::FileID(); 2832b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 2842b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static inline clang::FileID getTombstoneKey() { 2852b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return clang::FileID::getSentinel(); 2862b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 2872b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 2882b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static unsigned getHashValue(clang::FileID S) { 2892b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return S.getHashValue(); 2902b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 2912b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 2922b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static bool isEqual(clang::FileID LHS, clang::FileID RHS) { 2932b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return LHS == RHS; 2942b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 2952b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 2962b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static bool isPod() { return true; } 2972b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner }; 2982b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 2992b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner} // end namespace llvm 3002b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 3015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 302