1 //===- DebugLoc.h - Debug Location Information ------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines a number of light weight data structures used
11 // to describe and track debug location information.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_IR_DEBUGLOC_H
16 #define LLVM_IR_DEBUGLOC_H
18 #include "llvm/IR/TrackingMDRef.h"
19 #include "llvm/Support/DataTypes.h"
27 /// \brief A debug info location.
29 /// This class is a wrapper around a tracking reference to an \a MDLocation
32 /// To avoid extra includes, \a DebugLoc doubles the \a MDLocation API with a
33 /// one based on relatively opaque \a MDNode pointers.
35 TrackingMDNodeRef Loc;
39 DebugLoc(DebugLoc &&X) : Loc(std::move(X.Loc)) {}
40 DebugLoc(const DebugLoc &X) : Loc(X.Loc) {}
41 DebugLoc &operator=(DebugLoc &&X) {
42 Loc = std::move(X.Loc);
45 DebugLoc &operator=(const DebugLoc &X) {
50 /// \brief Construct from an \a MDLocation.
51 DebugLoc(MDLocation *L);
53 /// \brief Construct from an \a MDNode.
55 /// Note: if \c N is not an \a MDLocation, a verifier check will fail, and
56 /// accessors will crash. However, construction from other nodes is
57 /// supported in order to handle forward references when reading textual
59 explicit DebugLoc(MDNode *N);
61 /// \brief Get the underlying \a MDLocation.
63 /// \pre !*this or \c isa<MDLocation>(getAsMDNode()).
65 MDLocation *get() const;
66 operator MDLocation *() const { return get(); }
67 MDLocation *operator->() const { return get(); }
68 MDLocation &operator*() const { return *get(); }
71 /// \brief Check for null.
73 /// Check for null in a way that is safe with broken debug info. Unlike
74 /// the conversion to \c MDLocation, this doesn't require that \c Loc is of
75 /// the right type. Important for cases like \a llvm::StripDebugInfo() and
76 /// \a Instruction::hasMetadata().
77 explicit operator bool() const { return Loc; }
79 /// \brief Check whether this has a trivial destructor.
80 bool hasTrivialDestructor() const { return Loc.hasTrivialDestructor(); }
82 /// \brief Create a new DebugLoc.
84 /// Create a new DebugLoc at the specified line/col and scope/inline. This
85 /// forwards to \a MDLocation::get().
87 /// If \c !Scope, returns a default-constructed \a DebugLoc.
89 /// FIXME: Remove this. Users should use MDLocation::get().
90 static DebugLoc get(unsigned Line, unsigned Col, MDNode *Scope,
91 MDNode *InlinedAt = nullptr);
93 unsigned getLine() const;
94 unsigned getCol() const;
95 MDNode *getScope() const;
96 MDLocation *getInlinedAt() const;
98 /// \brief Get the fully inlined-at scope for a DebugLoc.
100 /// Gets the inlined-at scope for a DebugLoc.
101 MDNode *getInlinedAtScope() const;
103 /// \brief Find the debug info location for the start of the function.
105 /// Walk up the scope chain of given debug loc and find line number info
106 /// for the function.
108 /// FIXME: Remove this. Users should use MDLocation/MDLocalScope API to
109 /// find the subprogram, and then MDLocation::get().
110 DebugLoc getFnDebugLoc() const;
112 /// \brief Return \c this as a bar \a MDNode.
113 MDNode *getAsMDNode() const { return Loc; }
115 bool operator==(const DebugLoc &DL) const { return Loc == DL.Loc; }
116 bool operator!=(const DebugLoc &DL) const { return Loc != DL.Loc; }
120 /// \brief prints source location /path/to/file.exe:line:col @[inlined at]
121 void print(raw_ostream &OS) const;
124 } // end namespace llvm
126 #endif /* LLVM_SUPPORT_DEBUGLOC_H */