qt-creator/src/plugins/cpptools/cppprojectpartchooser.cpp

/****************************************************************************
**
** Copyright (C) 2016 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 "cppprojectpartchooser.h"

#include <utils/algorithm.h>
#include <utils/qtcassert.h>

namespace CppTools {
namespace Internal {

class ProjectPartPrioritizer
{
public:
    struct PrioritizedProjectPart
    {
        PrioritizedProjectPart(const ProjectPart::Ptr &projectPart, int priority)
            : projectPart(projectPart) , priority(priority) {}

        ProjectPart::Ptr projectPart;
        int priority = 0;
    };

    ProjectPartPrioritizer(const QList<ProjectPart::Ptr> &projectParts,
                           const ProjectExplorer::Project *activeProject,
                           Language languagePreference)
        : m_projectParts(projectParts)
        , m_activeProject(activeProject)
        , m_languagePreference(languagePreference)
    {
        // Determine best project part
        const QList<PrioritizedProjectPart> prioritized = prioritize();
        m_projectPart = prioritized.first().projectPart;

        // Determine ambiguity
        m_isAmbiguous = prioritized.size() > 1
                ? prioritized[0].priority == prioritized[1].priority
                : false;
    }

    ProjectPart::Ptr projectPart()
    {
        return m_projectPart;
    }

    bool isAmbiguous() const
    {
        return m_isAmbiguous;
    }

private:
    QList<PrioritizedProjectPart> prioritize()
    {
        // Prioritize
        QList<PrioritizedProjectPart> prioritized = Utils::transform(m_projectParts,
                [&](const ProjectPart::Ptr &projectPart) {
            return PrioritizedProjectPart{projectPart, priority(*projectPart)};
        });

        // Sort according to priority
        const auto lessThan = [&] (const PrioritizedProjectPart &p1,
                                   const PrioritizedProjectPart &p2) {
            return p1.priority > p2.priority;
        };
        std::stable_sort(prioritized.begin(), prioritized.end(), lessThan);

        return prioritized;
    }

    int priority(const ProjectPart &projectPart) const
    {
        int thePriority = 0;

        if (projectPart.project == m_activeProject)
            thePriority += 100;

        if (projectPart.selectedForBuilding)
            thePriority += 10;

        if (isPreferredLanguage(projectPart))
            thePriority += 1;

        return thePriority;
    }

    bool isPreferredLanguage(const ProjectPart &projectPart) const
    {
        const bool isCProjectPart = projectPart.languageVersion <= ProjectPart::LatestCVersion;
        return (m_languagePreference == Language::C && isCProjectPart)
            || (m_languagePreference == Language::Cxx && !isCProjectPart);
    }

private:
    const QList<ProjectPart::Ptr> m_projectParts;
    const ProjectExplorer::Project *m_activeProject = nullptr;
    Language m_languagePreference = Language::Cxx;

    // Results
    ProjectPart::Ptr m_projectPart;
    bool m_isAmbiguous = false;
};

ProjectPartInfo ProjectPartChooser::choose(
        const QString &filePath,
        const ProjectPart::Ptr &currentProjectPart,
        const ProjectPart::Ptr &manuallySetProjectPart,
        bool stickToPreviousProjectPart,
        const ProjectExplorer::Project *activeProject,
        Language languagePreference,
        bool projectHasChanged) const
{
    QTC_CHECK(m_projectPartsForFile);
    QTC_CHECK(m_projectPartsFromDependenciesForFile);
    QTC_CHECK(m_fallbackProjectPart);

    if (manuallySetProjectPart)
        return {manuallySetProjectPart, ProjectPartInfo::NoHint};

    ProjectPart::Ptr projectPart = currentProjectPart;
    ProjectPartInfo::Hint hint = ProjectPartInfo::NoHint;

    QList<ProjectPart::Ptr> projectParts = m_projectPartsForFile(filePath);
    if (projectParts.isEmpty()) {
        if (projectPart && stickToPreviousProjectPart)
            // File is not directly part of any project, but we got one before. We will re-use it,
            // because re-calculating this can be expensive when the dependency table is big.
            return {projectPart, ProjectPartInfo::NoHint};

        // Fall-back step 1: Get some parts through the dependency table:
        projectParts = m_projectPartsFromDependenciesForFile(filePath);
        if (projectParts.isEmpty()) {
            // Fall-back step 2: Use fall-back part from the model manager:
            projectPart = m_fallbackProjectPart();
            hint = ProjectPartInfo::IsFallbackMatch;
        } else {
            ProjectPartPrioritizer prioritizer(projectParts, activeProject, languagePreference);
            projectPart = prioritizer.projectPart();
        }
    } else {
        if (projectHasChanged || !projectParts.contains(projectPart)) {
            ProjectPartPrioritizer prioritizer(projectParts, activeProject, languagePreference);
            projectPart = prioritizer.projectPart();
            hint = prioritizer.isAmbiguous()
                    ? ProjectPartInfo::IsAmbiguousMatch
                    : ProjectPartInfo::NoHint;
        }
    }

    return {projectPart, hint};
}

void ProjectPartChooser::setFallbackProjectPart(const FallBackProjectPart &getter)
{
    m_fallbackProjectPart = getter;
}

void ProjectPartChooser::setProjectPartsForFile(const ProjectPartsForFile &getter)
{
    m_projectPartsForFile = getter;
}

void ProjectPartChooser::setProjectPartsFromDependenciesForFile(
        const ProjectPartsFromDependenciesForFile &getter)
{
    m_projectPartsFromDependenciesForFile = getter;
}

} // namespace Internal
} // namespace CppTools