File indexing completed on 2024-04-14 05:32:06

 /*
     SPDX-FileCopyrightText: 2016 Sergio Martins <smartins@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef CLAZY_CONTEXT_UTILS_H
 #define CLAZY_CONTEXT_UTILS_H
 
 #include "TypeUtils.h"
 
 #include <clang/AST/Decl.h>
 #include <clang/AST/DeclBase.h>
 #include <clang/AST/DeclCXX.h>
 #include <clang/AST/Stmt.h>
 #include <clang/AST/Type.h>
 #include <llvm/Support/Casting.h>
 
 #include <string>
 #include <vector>
 
 namespace clang
 {
 class ValueDecl;
 class DeclContext;
 class SourceManager;
 class SourceLocation;
 class CXXMethodDecl;
 class ParentMap;
 }
 
 namespace clazy
 {
 /**
  * Returns true if a decl is inside a function, instead of say a class field.
  * This returns true if "QList<int> l;" is a local variable, instead of being a class field such
  * as struct Foo { QList<int> l; }
  */
 inline bool isValueDeclInFunctionContext(const clang::ValueDecl *valueDecl)
 {
     const auto *context = valueDecl ? valueDecl->getDeclContext() : nullptr;
     return llvm::isa_and_nonnull<clang::FunctionDecl>(context) && !llvm::isa<clang::ParmVarDecl>(valueDecl);
 }
 
 /**
  * Returns the list of scopes for a decl context (namespaces, classes, inner classes, etc)
  * The inner ones are at the beginning of the list
  */
 std::vector<clang::DeclContext *> contextsForDecl(clang::DeclContext *);
 
 /**
  * Returns the first context for a decl.
  */
 inline clang::DeclContext *contextForDecl(clang::Decl *decl)
 {
     if (!decl) {
         return nullptr;
     }
 
     if (auto *context = llvm::dyn_cast<clang::DeclContext>(decl)) {
         return context;
     }
 
     return decl->getDeclContext();
 }
 
 inline clang::NamespaceDecl *namespaceForDecl(clang::Decl *decl)
 {
     if (!decl) {
         return nullptr;
     }
 
     clang::DeclContext *declContext = decl->getDeclContext();
     while (declContext) {
         if (auto *ns = llvm::dyn_cast<clang::NamespaceDecl>(declContext)) {
             return ns;
         }
 
         declContext = declContext->getParent();
     }
 
     return nullptr;
 }
 
 inline clang::NamespaceDecl *namespaceForType(clang::QualType q)
 {
     if (q.isNull()) {
         return nullptr;
     }
 
     q = clazy::pointeeQualType(q);
     // Check if it's a class, struct, union or enum
     clang::TagDecl *rec = q->getAsTagDecl();
     if (rec) {
         return namespaceForDecl(rec);
     }
 
     // Or maybe it's a typedef to a builtin type:
     const auto *typeDefType = q->getAs<clang::TypedefType>();
     if (typeDefType) {
         clang::TypedefNameDecl *typedeff = typeDefType->getDecl();
         return namespaceForDecl(typedeff);
     }
 
     return nullptr;
 }
 
 inline clang::NamespaceDecl *namespaceForFunction(clang::FunctionDecl *func)
 {
     if (auto *ns = llvm::dyn_cast<clang::NamespaceDecl>(func->getDeclContext())) {
         return ns;
     }
 
     return namespaceForDecl(func);
 }
 
 /**
  * Returns the first context of type T in which the specified context is in.
  * Contexts are namespaces, classes, inner classes, functions, etc.
 
  */
 template<typename T>
 T *firstContextOfType(clang::DeclContext *context)
 {
     if (!context) {
         return nullptr;
     }
 
     if (llvm::isa<T>(context)) {
         return llvm::cast<T>(context);
     }
 
     return clazy::firstContextOfType<T>(context->getParent());
 }
 
 /**
  * Returns fully/semi-fully qualified name for a method, but doesn't over-qualify with namespaces
  * which we're already in.
  *
  * if currentScope == nullptr will return a fully qualified name
  */
 
 std::string getMostNeededQualifiedName(const clang::SourceManager &sourceManager,
                                        clang::CXXMethodDecl *method,
                                        clang::DeclContext *currentScope,
                                        clang::SourceLocation usageLoc,
                                        bool honourUsingDirectives);
 
 /**
  * Returns true, if in a specific context, we can take the address of a method
  * for example doing &ClassName::SomePrivateMember might not be possible if the member is private
  * but might be possible if we're in a context which is friend of ClassName
  * Or it might be protected but context is a derived class
  *
  * When inside a derived class scope it's possible to take the address of a protected base method
  * but only if you qualify it with the derived class name, so &Derived::baseMethod, instead of &Base::baseMethod
  * If this was the case then isSpecialProtectedCase will be true
  */
 bool canTakeAddressOf(clang::CXXMethodDecl *method, clang::DeclContext *context, bool &isSpecialProtectedCase);
 
 }
 
 #endif