/usr/lib/llvm-3.4/include/lldb/Expression/ClangASTSource.h is in liblldb-3.4-dev 1:3.4.2-13.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 | //===-- ClangASTSource.h ----------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#ifndef liblldb_ClangASTSource_h_
#define liblldb_ClangASTSource_h_
#include <set>
#include "clang/Basic/IdentifierTable.h"
#include "lldb/Symbol/ClangExternalASTSourceCommon.h"
#include "lldb/Symbol/ClangASTImporter.h"
#include "lldb/Target/Target.h"
#include "llvm/ADT/SmallSet.h"
namespace lldb_private {
//----------------------------------------------------------------------
/// @class ClangASTSource ClangASTSource.h "lldb/Expression/ClangASTSource.h"
/// @brief Provider for named objects defined in the debug info for Clang
///
/// As Clang parses an expression, it may encounter names that are not
/// defined inside the expression, including variables, functions, and
/// types. Clang knows the name it is looking for, but nothing else.
/// The ExternalSemaSource class provides Decls (VarDecl, FunDecl, TypeDecl)
/// to Clang for these names, consulting the ClangExpressionDeclMap to do
/// the actual lookups.
//----------------------------------------------------------------------
class ClangASTSource :
public ClangExternalASTSourceCommon,
public ClangASTImporter::MapCompleter
{
public:
//------------------------------------------------------------------
/// Constructor
///
/// Initializes class variables.
///
/// @param[in] declMap
/// A reference to the LLDB object that handles entity lookup.
//------------------------------------------------------------------
ClangASTSource (const lldb::TargetSP &target) :
m_import_in_progress (false),
m_lookups_enabled (false),
m_target (target),
m_ast_context (NULL),
m_active_lookups ()
{
m_ast_importer = m_target->GetClangASTImporter();
}
//------------------------------------------------------------------
/// Destructor
//------------------------------------------------------------------
~ClangASTSource();
//------------------------------------------------------------------
/// Interface stubs.
//------------------------------------------------------------------
clang::Decl *GetExternalDecl (uint32_t) { return NULL; }
clang::Stmt *GetExternalDeclStmt (uint64_t) { return NULL; }
clang::Selector GetExternalSelector (uint32_t) { return clang::Selector(); }
uint32_t GetNumExternalSelectors () { return 0; }
clang::CXXBaseSpecifier *GetExternalCXXBaseSpecifiers (uint64_t Offset)
{ return NULL; }
void MaterializeVisibleDecls (const clang::DeclContext *DC)
{ return; }
void InstallASTContext (clang::ASTContext *ast_context)
{
m_ast_context = ast_context;
m_ast_importer->InstallMapCompleter(ast_context, *this);
}
//
// APIs for ExternalASTSource
//
//------------------------------------------------------------------
/// Look up all Decls that match a particular name. Only handles
/// Identifiers and DeclContexts that are either NamespaceDecls or
/// TranslationUnitDecls. Calls SetExternalVisibleDeclsForName with
/// the result.
///
/// The work for this function is done by
/// void FindExternalVisibleDecls (NameSearchContext &);
///
/// @param[in] DC
/// The DeclContext to register the found Decls in.
///
/// @param[in] Name
/// The name to find entries for.
///
/// @return
/// Whatever SetExternalVisibleDeclsForName returns.
//------------------------------------------------------------------
bool
FindExternalVisibleDeclsByName (const clang::DeclContext *DC,
clang::DeclarationName Name);
//------------------------------------------------------------------
/// Enumerate all Decls in a given lexical context.
///
/// @param[in] DC
/// The DeclContext being searched.
///
/// @param[in] isKindWeWant
/// If non-NULL, a callback function that returns true given the
/// DeclKinds of desired Decls, and false otherwise.
///
/// @param[in] Decls
/// A vector that is filled in with matching Decls.
//------------------------------------------------------------------
clang::ExternalLoadResult
FindExternalLexicalDecls (const clang::DeclContext *DC,
bool (*isKindWeWant)(clang::Decl::Kind),
llvm::SmallVectorImpl<clang::Decl*> &Decls);
//------------------------------------------------------------------
/// Specify the layout of the contents of a RecordDecl.
///
/// @param[in] Record
/// The record (in the parser's AST context) that needs to be
/// laid out.
///
/// @param[out] Size
/// The total size of the record in bits.
///
/// @param[out] Alignment
/// The alignment of the record in bits.
///
/// @param[in] FieldOffsets
/// A map that must be populated with pairs of the record's
/// fields (in the parser's AST context) and their offsets
/// (measured in bits).
///
/// @param[in] BaseOffsets
/// A map that must be populated with pairs of the record's
/// C++ concrete base classes (in the parser's AST context,
/// and only if the record is a CXXRecordDecl and has base
/// classes) and their offsets (measured in bytes).
///
/// @param[in] VirtualBaseOffsets
/// A map that must be populated with pairs of the record's
/// C++ virtual base classes (in the parser's AST context,
/// and only if the record is a CXXRecordDecl and has base
/// classes) and their offsets (measured in bytes).
///
/// @return
/// True <=> the layout is valid.
//-----------------------------------------------------------------
bool
layoutRecordType(const clang::RecordDecl *Record,
uint64_t &Size,
uint64_t &Alignment,
llvm::DenseMap <const clang::FieldDecl *, uint64_t> &FieldOffsets,
llvm::DenseMap <const clang::CXXRecordDecl *, clang::CharUnits> &BaseOffsets,
llvm::DenseMap <const clang::CXXRecordDecl *, clang::CharUnits> &VirtualBaseOffsets);
//------------------------------------------------------------------
/// Complete a TagDecl.
///
/// @param[in] Tag
/// The Decl to be completed in place.
//------------------------------------------------------------------
virtual void
CompleteType (clang::TagDecl *Tag);
//------------------------------------------------------------------
/// Complete an ObjCInterfaceDecl.
///
/// @param[in] Class
/// The Decl to be completed in place.
//------------------------------------------------------------------
virtual void
CompleteType (clang::ObjCInterfaceDecl *Class);
//------------------------------------------------------------------
/// Called on entering a translation unit. Tells Clang by calling
/// setHasExternalVisibleStorage() and setHasExternalLexicalStorage()
/// that this object has something to say about undefined names.
///
/// @param[in] ASTConsumer
/// Unused.
//------------------------------------------------------------------
void StartTranslationUnit (clang::ASTConsumer *Consumer);
//
// APIs for NamespaceMapCompleter
//
//------------------------------------------------------------------
/// Look up the modules containing a given namespace and put the
/// appropriate entries in the namespace map.
///
/// @param[in] namespace_map
/// The map to be completed.
///
/// @param[in] name
/// The name of the namespace to be found.
///
/// @param[in] parent_map
/// The map for the namespace's parent namespace, if there is
/// one.
//------------------------------------------------------------------
void CompleteNamespaceMap (ClangASTImporter::NamespaceMapSP &namespace_map,
const ConstString &name,
ClangASTImporter::NamespaceMapSP &parent_map) const;
//
// Helper APIs
//
clang::NamespaceDecl *
AddNamespace (NameSearchContext &context,
ClangASTImporter::NamespaceMapSP &namespace_decls);
//------------------------------------------------------------------
/// The worker function for FindExternalVisibleDeclsByName.
///
/// @param[in] context
/// The NameSearchContext to use when filing results.
//------------------------------------------------------------------
virtual void FindExternalVisibleDecls (NameSearchContext &context);
void SetImportInProgress (bool import_in_progress) { m_import_in_progress = import_in_progress; }
bool GetImportInProgress () { return m_import_in_progress; }
void SetLookupsEnabled (bool lookups_enabled) { m_lookups_enabled = lookups_enabled; }
bool GetLookupsEnabled () { return m_lookups_enabled; }
//----------------------------------------------------------------------
/// @class ClangASTSourceProxy ClangASTSource.h "lldb/Expression/ClangASTSource.h"
/// @brief Proxy for ClangASTSource
///
/// Clang AST contexts like to own their AST sources, so this is a
/// state-free proxy object.
//----------------------------------------------------------------------
class ClangASTSourceProxy : public ClangExternalASTSourceCommon
{
public:
ClangASTSourceProxy (ClangASTSource &original) :
m_original(original)
{
}
bool
FindExternalVisibleDeclsByName (const clang::DeclContext *DC,
clang::DeclarationName Name)
{
return m_original.FindExternalVisibleDeclsByName(DC, Name);
}
clang::ExternalLoadResult
FindExternalLexicalDecls (const clang::DeclContext *DC,
bool (*isKindWeWant)(clang::Decl::Kind),
llvm::SmallVectorImpl<clang::Decl*> &Decls)
{
return m_original.FindExternalLexicalDecls(DC, isKindWeWant, Decls);
}
void
CompleteType (clang::TagDecl *Tag)
{
return m_original.CompleteType(Tag);
}
void
CompleteType (clang::ObjCInterfaceDecl *Class)
{
return m_original.CompleteType(Class);
}
bool
layoutRecordType(const clang::RecordDecl *Record,
uint64_t &Size,
uint64_t &Alignment,
llvm::DenseMap <const clang::FieldDecl *, uint64_t> &FieldOffsets,
llvm::DenseMap <const clang::CXXRecordDecl *, clang::CharUnits> &BaseOffsets,
llvm::DenseMap <const clang::CXXRecordDecl *, clang::CharUnits> &VirtualBaseOffsets)
{
return m_original.layoutRecordType(Record,
Size,
Alignment,
FieldOffsets,
BaseOffsets,
VirtualBaseOffsets);
}
void StartTranslationUnit (clang::ASTConsumer *Consumer)
{
return m_original.StartTranslationUnit(Consumer);
}
ClangASTMetadata *
GetMetadata(const void * object)
{
return m_original.GetMetadata(object);
}
void
SetMetadata(const void * object, ClangASTMetadata &metadata)
{
return m_original.SetMetadata(object, metadata);
}
bool
HasMetadata(const void * object)
{
return m_original.HasMetadata(object);
}
private:
ClangASTSource &m_original;
};
clang::ExternalASTSource *CreateProxy()
{
return new ClangASTSourceProxy(*this);
}
protected:
//------------------------------------------------------------------
/// Look for the complete version of an Objective-C interface, and
/// return it if found.
///
/// @param[in] interface_decl
/// An ObjCInterfaceDecl that may not be the complete one.
///
/// @return
/// NULL if the complete interface couldn't be found;
/// the complete interface otherwise.
//------------------------------------------------------------------
clang::ObjCInterfaceDecl *
GetCompleteObjCInterface (clang::ObjCInterfaceDecl *interface_decl);
//------------------------------------------------------------------
/// Find all entities matching a given name in a given module,
/// using a NameSearchContext to make Decls for them.
///
/// @param[in] context
/// The NameSearchContext that can construct Decls for this name.
///
/// @param[in] module
/// If non-NULL, the module to query.
///
/// @param[in] namespace_decl
/// If valid and module is non-NULL, the parent namespace.
///
/// @param[in] current_id
/// The ID for the current FindExternalVisibleDecls invocation,
/// for logging purposes.
///
/// @return
/// True on success; false otherwise.
//------------------------------------------------------------------
void
FindExternalVisibleDecls (NameSearchContext &context,
lldb::ModuleSP module,
ClangNamespaceDecl &namespace_decl,
unsigned int current_id);
//------------------------------------------------------------------
/// Find all Objective-C methods matching a given selector.
///
/// @param[in] context
/// The NameSearchContext that can construct Decls for this name.
/// Its m_decl_name contains the selector and its m_decl_context
/// is the containing object.
//------------------------------------------------------------------
void
FindObjCMethodDecls (NameSearchContext &context);
//------------------------------------------------------------------
/// Find all Objective-C properties and ivars with a given name.
///
/// @param[in] context
/// The NameSearchContext that can construct Decls for this name.
/// Its m_decl_name contains the name and its m_decl_context
/// is the containing object.
//------------------------------------------------------------------
void
FindObjCPropertyAndIvarDecls (NameSearchContext &context);
//------------------------------------------------------------------
/// A wrapper for ClangASTContext::CopyType that sets a flag that
/// indicates that we should not respond to queries during import.
///
/// @param[in] dest_context
/// The target AST context, typically the parser's AST context.
///
/// @param[in] source_context
/// The source AST context, typically the AST context of whatever
/// symbol file the type was found in.
///
/// @param[in] clang_type
/// The source type.
///
/// @return
/// The imported type.
//------------------------------------------------------------------
ClangASTType
GuardedCopyType (const ClangASTType &src_type);
friend struct NameSearchContext;
bool m_import_in_progress;
bool m_lookups_enabled;
const lldb::TargetSP m_target; ///< The target to use in finding variables and types.
clang::ASTContext *m_ast_context; ///< The AST context requests are coming in for.
ClangASTImporter *m_ast_importer; ///< The target's AST importer.
std::set<const char *> m_active_lookups;
};
//----------------------------------------------------------------------
/// @class NameSearchContext ClangASTSource.h "lldb/Expression/ClangASTSource.h"
/// @brief Container for all objects relevant to a single name lookup
///
/// LLDB needs to create Decls for entities it finds. This class communicates
/// what name is being searched for and provides helper functions to construct
/// Decls given appropriate type information.
//----------------------------------------------------------------------
struct NameSearchContext {
ClangASTSource &m_ast_source; ///< The AST source making the request
llvm::SmallVectorImpl<clang::NamedDecl*> &m_decls; ///< The list of declarations already constructed
ClangASTImporter::NamespaceMapSP m_namespace_map; ///< The mapping of all namespaces found for this request back to their modules
const clang::DeclarationName &m_decl_name; ///< The name being looked for
const clang::DeclContext *m_decl_context; ///< The DeclContext to put declarations into
llvm::SmallSet <ClangASTType, 5> m_function_types; ///< All the types of functions that have been reported, so we don't report conflicts
struct {
bool variable : 1;
bool function_with_type_info : 1;
bool function : 1;
} m_found;
//------------------------------------------------------------------
/// Constructor
///
/// Initializes class variables.
///
/// @param[in] astSource
/// A reference to the AST source making a request.
///
/// @param[in] decls
/// A reference to a list into which new Decls will be placed. This
/// list is typically empty when the function is called.
///
/// @param[in] name
/// The name being searched for (always an Identifier).
///
/// @param[in] dc
/// The DeclContext to register Decls in.
//------------------------------------------------------------------
NameSearchContext (ClangASTSource &astSource,
llvm::SmallVectorImpl<clang::NamedDecl*> &decls,
clang::DeclarationName &name,
const clang::DeclContext *dc) :
m_ast_source(astSource),
m_decls(decls),
m_decl_name(name),
m_decl_context(dc)
{
memset(&m_found, 0, sizeof(m_found));
}
//------------------------------------------------------------------
/// Create a VarDecl with the name being searched for and the provided
/// type and register it in the right places.
///
/// @param[in] type
/// The opaque QualType for the VarDecl being registered.
//------------------------------------------------------------------
clang::NamedDecl *AddVarDecl(const ClangASTType &type);
//------------------------------------------------------------------
/// Create a FunDecl with the name being searched for and the provided
/// type and register it in the right places.
///
/// @param[in] type
/// The opaque QualType for the FunDecl being registered.
//------------------------------------------------------------------
clang::NamedDecl *AddFunDecl(const ClangASTType &type);
//------------------------------------------------------------------
/// Create a FunDecl with the name being searched for and generic
/// type (i.e. intptr_t NAME_GOES_HERE(...)) and register it in the
/// right places.
//------------------------------------------------------------------
clang::NamedDecl *AddGenericFunDecl();
//------------------------------------------------------------------
/// Create a TypeDecl with the name being searched for and the provided
/// type and register it in the right places.
///
/// @param[in] type
/// The opaque QualType for the TypeDecl being registered.
//------------------------------------------------------------------
clang::NamedDecl *AddTypeDecl(const ClangASTType &clang_type);
//------------------------------------------------------------------
/// Add Decls from the provided DeclContextLookupResult to the list
/// of results.
///
/// @param[in] result
/// The DeclContextLookupResult, usually returned as the result
/// of querying a DeclContext.
//------------------------------------------------------------------
void AddLookupResult (clang::DeclContextLookupConstResult result);
//------------------------------------------------------------------
/// Add a NamedDecl to the list of results.
///
/// @param[in] decl
/// The NamedDecl, usually returned as the result
/// of querying a DeclContext.
//------------------------------------------------------------------
void AddNamedDecl (clang::NamedDecl *decl);
};
}
#endif
|