qt-creator/src/tools/clangrefactoringbackend/source/indexdataconsumer.cpp

/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#include "indexdataconsumer.h"
#include "collectsymbolsaction.h"
#include "filestatuspreprocessorcallbacks.h"

#include <clang/AST/DeclVisitor.h>
#include <clang/Basic/SourceLocation.h>
#include <clang/Index/IndexSymbol.h>
#include <clang/Index/IndexingAction.h>

#include <llvm/ADT/ArrayRef.h>

#include <iostream>

namespace ClangBackEnd {

namespace  {
bool hasSymbolRole(clang::index::SymbolRole role, clang::index::SymbolRoleSet roleSet)
{
    return roleSet & static_cast<clang::index::SymbolRoleSet>(role);
}

Utils::SmallString symbolName(const clang::NamedDecl *declaration)
{
    clang::DeclarationName declarationName(declaration->getIdentifier());

    return declarationName.getAsString();
}

SourceLocationKind sourceLocationKind(clang::index::SymbolRoleSet roles)
{
    if (hasSymbolRole(clang::index::SymbolRole::Reference, roles))
        return SourceLocationKind::DeclarationReference;
    else if (hasSymbolRole(clang::index::SymbolRole::Declaration, roles))
        return SourceLocationKind::Declaration;
    else if (hasSymbolRole(clang::index::SymbolRole::Definition, roles))
        return SourceLocationKind::Definition;

    return SourceLocationKind::None;
}

using SymbolKindAndTags = std::pair<SymbolKind, SymbolTags>;

class IndexingDeclVisitor : public clang::ConstDeclVisitor<IndexingDeclVisitor, SymbolKindAndTags>
{
public:
    SymbolKindAndTags VisitEnumDecl(const clang::EnumDecl *declaration)
    {
        return {SymbolKind::Enumeration, {}};;
    }
    SymbolKindAndTags VisitRecordDecl(const clang::RecordDecl *declaration)
    {
        SymbolKindAndTags result = {SymbolKind::Record, {}};
        switch (declaration->getTagKind()) {
        case clang::TTK_Struct: result.second.push_back(SymbolTag::Struct); break;
        case clang::TTK_Interface: result.second.push_back(SymbolTag::MsvcInterface); break;
        case clang::TTK_Union: result.second.push_back(SymbolTag::Union); break;
        case clang::TTK_Class: result.second.push_back(SymbolTag::Class); break;
        case clang::TTK_Enum: break; // this case can never happen in a record but it is there to silent the warning
        }

        return result;
    }

    SymbolKindAndTags VisitFunctionDecl(const clang::FunctionDecl*)
    {
        return {SymbolKind::Function, {}};
    }

    SymbolKindAndTags VisitVarDecl(const clang::VarDecl*)
    {
        return {SymbolKind::Variable, {}};
    }
};

SymbolKindAndTags symbolKindAndTags(const clang::Decl *declaration)
{
    static IndexingDeclVisitor visitor;
    return visitor.Visit(declaration);
}

} // namespace

bool IndexDataConsumer::skipSymbol(clang::FileID fileId, clang::index::SymbolRoleSet symbolRoles)
{
    return isAlreadyParsed(fileId, m_symbolSourcesManager)
           && !m_symbolSourcesManager.dependentFilesModified();
}

bool IndexDataConsumer::isAlreadyParsed(clang::FileID fileId, SourcesManager &sourcesManager)
{
    const clang::FileEntry *fileEntry = m_sourceManager->getFileEntryForID(fileId);
    if (!fileEntry)
        return false;
    return sourcesManager.alreadyParsed(filePathId(fileEntry), fileEntry->getModificationTime());
}

void IndexDataConsumer::setPreprocessor(std::shared_ptr<clang::Preprocessor> preprocessor)
{
    preprocessor->addPPCallbacks(std::make_unique<FileStatusPreprocessorCallbacks>(
        m_fileStatuses, m_filePathCache, m_sourceManager, m_filePathIndices));
}

bool IndexDataConsumer::handleDeclOccurence(const clang::Decl *declaration,
                                            clang::index::SymbolRoleSet symbolRoles,
                                            llvm::ArrayRef<clang::index::SymbolRelation> /*symbolRelations*/,
                                            clang::SourceLocation sourceLocation,
                                            IndexDataConsumer::ASTNodeInfo /*astNodeInfo*/)
{
    const auto *namedDeclaration = clang::dyn_cast<clang::NamedDecl>(declaration);
    if (namedDeclaration) {
        if (!namedDeclaration->getIdentifier())
            return true;

        if (skipSymbol(m_sourceManager->getFileID(sourceLocation), symbolRoles))
            return true;

        SymbolIndex globalId = toSymbolIndex(declaration->getCanonicalDecl());

        auto found = m_symbolEntries.find(globalId);
        if (found == m_symbolEntries.end()) {
            Utils::optional<Utils::PathString> usr = generateUSR(namedDeclaration);
            if (usr) {
                auto  kindAndTags = symbolKindAndTags(declaration);
                m_symbolEntries.emplace(std::piecewise_construct,
                                        std::forward_as_tuple(globalId),
                                        std::forward_as_tuple(std::move(*usr),
                                                              symbolName(namedDeclaration),
                                                              kindAndTags.first,
                                                              kindAndTags.second));
            }
        }

        m_sourceLocationEntries.emplace_back(globalId,
                                             filePathId(sourceLocation),
                                             lineColum(sourceLocation),
                                             sourceLocationKind(symbolRoles));
    }

    return true;
}

namespace {

SourceLocationKind macroSymbolType(clang::index::SymbolRoleSet roles)
{
    if (roles & static_cast<clang::index::SymbolRoleSet>(clang::index::SymbolRole::Definition))
        return SourceLocationKind::MacroDefinition;

    if (roles & static_cast<clang::index::SymbolRoleSet>(clang::index::SymbolRole::Undefinition))
        return SourceLocationKind::MacroUndefinition;

    if (roles & static_cast<clang::index::SymbolRoleSet>(clang::index::SymbolRole::Reference))
        return SourceLocationKind::MacroUsage;

    return SourceLocationKind::None;
}

} // namespace

bool IndexDataConsumer::handleMacroOccurence(const clang::IdentifierInfo *identifierInfo,
                                             const clang::MacroInfo *macroInfo,
                                             clang::index::SymbolRoleSet roles,
                                             clang::SourceLocation sourceLocation)
{
    if (macroInfo && sourceLocation.isFileID()
        && !isAlreadyParsed(m_sourceManager->getFileID(sourceLocation), m_macroSourcesManager)
        && !isInSystemHeader(sourceLocation)) {
        FilePathId fileId = filePathId(sourceLocation);
        if (fileId.isValid()) {
            auto macroName = identifierInfo->getName();
            SymbolIndex globalId = toSymbolIndex(macroInfo);

            auto found = m_symbolEntries.find(globalId);
            if (found == m_symbolEntries.end()) {
                Utils::optional<Utils::PathString> usr = generateUSR(macroName, sourceLocation);
                if (usr) {
                    m_symbolEntries.emplace(std::piecewise_construct,
                                            std::forward_as_tuple(globalId),
                                            std::forward_as_tuple(std::move(*usr),
                                                                  macroName,
                                                                  SymbolKind::Macro));
                }
            }

            m_sourceLocationEntries.emplace_back(globalId,
                                                 fileId,
                                                 lineColum(sourceLocation),
                                                 macroSymbolType(roles));
        }
    }

    return true;
}

void IndexDataConsumer::finish()
{
    m_macroSourcesManager.updateModifiedTimeStamps();
    m_symbolSourcesManager.updateModifiedTimeStamps();
    m_filePathIndices.clear();
}

} // namespace ClangBackEnd