qt-creator/src/plugins/cpptools/cpptoolsplugin.h

/****************************************************************************
**
** 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.
**
****************************************************************************/

#pragma once

#include "cpptools_global.h"

#include <projectexplorer/projectexplorer.h>

namespace Utils { class FilePath; }

namespace CppTools {

class CppCodeModelSettings;

namespace Internal {

struct CppFileSettings;

class CppToolsPlugin final : public ExtensionSystem::IPlugin
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "CppTools.json")

public:
    CppToolsPlugin();
    ~CppToolsPlugin() final;

    static CppToolsPlugin *instance();
    static const QStringList &headerSearchPaths();
    static const QStringList &sourceSearchPaths();
    static const QStringList &headerPrefixes();
    static const QStringList &sourcePrefixes();
    static void clearHeaderSourceCache();
    static Utils::FilePath licenseTemplatePath();
    static QString licenseTemplate();
    static bool usePragmaOnce();

    bool initialize(const QStringList &arguments, QString *errorMessage) final;
    void extensionsInitialized() final;

    CppCodeModelSettings *codeModelSettings();

public slots:
    void switchHeaderSource();
    void switchHeaderSourceInNextSplit();

#ifdef WITH_TESTS
private slots:
    // Init/Cleanup methods implemented in cppheadersource_test.cpp
    void initTestCase();
    void cleanupTestCase();

    void test_codegen_public_in_empty_class();
    void test_codegen_public_in_nonempty_class();
    void test_codegen_public_before_protected();
    void test_codegen_private_after_protected();
    void test_codegen_protected_in_nonempty_class();
    void test_codegen_protected_between_public_and_private();
    void test_codegen_qtdesigner_integration();
    void test_codegen_definition_empty_class();
    void test_codegen_definition_first_member();
    void test_codegen_definition_last_member();
    void test_codegen_definition_middle_member();
    void test_codegen_definition_middle_member_surrounded_by_undefined();
    void test_codegen_definition_member_specific_file();

    void test_completion_basic_1();

    void test_completion_template_function_data();
    void test_completion_template_function();

    void test_completion_data();
    void test_completion();

    void test_global_completion_data();
    void test_global_completion();

    void test_doxygen_tag_completion_data();
    void test_doxygen_tag_completion();

    void test_completion_member_access_operator_data();
    void test_completion_member_access_operator();

    void test_completion_prefix_first_QTCREATORBUG_8737();
    void test_completion_prefix_first_QTCREATORBUG_9236();

    void test_format_pointerdeclaration_in_simpledeclarations();
    void test_format_pointerdeclaration_in_simpledeclarations_data();
    void test_format_pointerdeclaration_in_controlflowstatements();
    void test_format_pointerdeclaration_in_controlflowstatements_data();
    void test_format_pointerdeclaration_multiple_declarators();
    void test_format_pointerdeclaration_multiple_declarators_data();
    void test_format_pointerdeclaration_multiple_matches();
    void test_format_pointerdeclaration_multiple_matches_data();
    void test_format_pointerdeclaration_macros();
    void test_format_pointerdeclaration_macros_data();

    void test_cppsourceprocessor_includes_resolvedUnresolved();
    void test_cppsourceprocessor_includes_cyclic();
    void test_cppsourceprocessor_includes_allDiagnostics();
    void test_cppsourceprocessor_macroUses();
    void test_cppsourceprocessor_includeNext();

    void test_functionutils_virtualFunctions();
    void test_functionutils_virtualFunctions_data();

    void test_modelmanager_paths_are_clean();
    void test_modelmanager_framework_headers();
    void test_modelmanager_refresh_also_includes_of_project_files();
    void test_modelmanager_refresh_several_times();
    void test_modelmanager_refresh_test_for_changes();
    void test_modelmanager_refresh_added_and_purge_removed();
    void test_modelmanager_refresh_timeStampModified_if_sourcefiles_change();
    void test_modelmanager_refresh_timeStampModified_if_sourcefiles_change_data();
    void test_modelmanager_snapshot_after_two_projects();
    void test_modelmanager_extraeditorsupport_uiFiles();
    void test_modelmanager_gc_if_last_cppeditor_closed();
    void test_modelmanager_dont_gc_opened_files();
    void test_modelmanager_defines_per_project();
    void test_modelmanager_defines_per_editor();
    void test_modelmanager_updateEditorsAfterProjectUpdate();
    void test_modelmanager_precompiled_headers();
    void test_modelmanager_renameIncludes();
    void test_modelmanager_renameIncludesInEditor();
    void test_modelmanager_documentsAndRevisions();

    void test_cpplocatorfilters_CppLocatorFilter();
    void test_cpplocatorfilters_CppLocatorFilter_data();
    void test_cpplocatorfilters_CppCurrentDocumentFilter();
    void test_cpplocatorfilters_CppCurrentDocumentHighlighting();
    void test_cpplocatorfilters_CppFunctionsFilterHighlighting();

    void test_builtinsymbolsearcher();
    void test_builtinsymbolsearcher_data();

    void test_headersource_data();
    void test_headersource();

    void test_typehierarchy_data();
    void test_typehierarchy();

    void test_cpplocalsymbols_data();
    void test_cpplocalsymbols();

    void test_includeGroups_detectIncludeGroupsByNewLines();
    void test_includeGroups_detectIncludeGroupsByIncludeDir();
    void test_includeGroups_detectIncludeGroupsByIncludeType();

    void test_optionsBuilder_addProjectMacros();
    void test_optionsBuilder_unknownFlagsAreForwarded();
    void test_optionsBuilder_warningsFlagsAreNotFilteredIfRequested();
    void test_optionsBuilder_diagnosticOptionsAreRemoved();
    void test_optionsBuilder_cLanguageVersionIsRewritten();
    void test_optionsBuilder_languageVersionIsExplicitlySetIfNotProvided();
    void test_optionsBuilder_LanguageVersionIsExplicitlySetIfNotProvidedMsvc();
    void test_optionsBuilder_addWordWidth();
    void test_optionsBuilder_headerPathOptionsOrder();
    void test_optionsBuilder_HeaderPathOptionsOrderMsvc();
    void test_optionsBuilder_useSystemHeader();
    void test_optionsBuilder_noClangHeadersPath();
    void test_optionsBuilder_clangHeadersAndCppIncludePathsOrderMacOs();
    void test_optionsBuilder_clangHeadersAndCppIncludePathsOrderLinux();
    void test_optionsBuilder_clangHeadersAndCppIncludePathsOrderNoVersion();
    void test_optionsBuilder_clangHeadersAndCppIncludePathsOrderAndroidClang();
    void test_optionsBuilder_noPrecompiledHeader();
    void test_optionsBuilder_usePrecompiledHeader();
    void test_optionsBuilder_usePrecompiledHeaderMsvc();
    void test_optionsBuilder_addMacros();
    void test_optionsBuilder_addTargetTriple();
    void test_optionsBuilder_enableCExceptions();
    void test_optionsBuilder_enableCxxExceptions();
    void test_optionsBuilder_insertWrappedQtHeaders();
    void test_optionsBuilder_insertWrappedMingwHeadersWithNonMingwToolchain();
    void test_optionsBuilder_insertWrappedMingwHeadersWithMingwToolchain();
    void test_optionsBuilder_setLanguageVersion();
    void test_optionsBuilder_setLanguageVersionMsvc();
    void test_optionsBuilder_handleLanguageExtension();
    void test_optionsBuilder_updateLanguageVersion();
    void test_optionsBuilder_updateLanguageVersionMsvc();
    void test_optionsBuilder_addMsvcCompatibilityVersion();
    void test_optionsBuilder_undefineCppLanguageFeatureMacrosForMsvc2015();
    void test_optionsBuilder_addDefineFunctionMacrosMsvc();
    void test_optionsBuilder_addProjectConfigFileInclude();
    void test_optionsBuilder_addProjectConfigFileIncludeMsvc();
    void test_optionsBuilder_noUndefineClangVersionMacrosForNewMsvc();
    void test_optionsBuilder_undefineClangVersionMacrosForOldMsvc();
    void test_optionsBuilder_buildAllOptions();
    void test_optionsBuilder_buildAllOptionsMsvc();
    void test_optionsBuilder_buildAllOptionsMsvcWithExceptions();

    void test_projectPartChooser_chooseManuallySet();
    void test_projectPartChooser_indicateManuallySet();
    void test_projectPartChooser_indicateManuallySetForFallbackToProjectPartFromDependencies();
    void test_projectPartChooser_doNotIndicateNotManuallySet();
    void test_projectPartChooser_forMultipleChooseFromActiveProject();
    void test_projectPartChooser_forMultiplePreferSelectedForBuilding();
    void test_projectPartChooser_forMultipleFromDependenciesChooseFromActiveProject();
    void test_projectPartChooser_forMultipleCheckIfActiveProjectChanged();
    void test_projectPartChooser_forMultipleAndAmbigiousHeaderPreferCProjectPart();
    void test_projectPartChooser_forMultipleAndAmbigiousHeaderPreferCxxProjectPart();
    void test_projectPartChooser_indicateMultiple();
    void test_projectPartChooser_indicateMultipleForFallbackToProjectPartFromDependencies();
    void test_projectPartChooser_forMultipleChooseNewIfPreviousIsGone();
    void test_projectPartChooser_fallbackToProjectPartFromDependencies();
    void test_projectPartChooser_fallbackToProjectPartFromModelManager();
    void test_projectPartChooser_continueUsingFallbackFromModelManagerIfProjectDoesNotChange();
    void test_projectPartChooser_stopUsingFallbackFromModelManagerIfProjectChanges1();
    void test_projectPartChooser_stopUsingFallbackFromModelManagerIfProjectChanges2();
    void test_projectPartChooser_indicateFallbacktoProjectPartFromModelManager();
    void test_projectPartChooser_indicateFromDependencies();
    void test_projectPartChooser_doNotIndicateFromDependencies();

    void test_projectInfoGenerator_createNoProjectPartsForEmptyFileList();
    void test_projectInfoGenerator_createSingleProjectPart();
    void test_projectInfoGenerator_createMultipleProjectParts();
    void test_projectInfoGenerator_projectPartIndicatesObjectiveCExtensionsByDefault();
    void test_projectInfoGenerator_projectPartHasLatestLanguageVersionByDefault();
    void test_projectInfoGenerator_useMacroInspectionReportForLanguageVersion();
    void test_projectInfoGenerator_useCompilerFlagsForLanguageExtensions();
    void test_projectInfoGenerator_projectFileKindsMatchProjectPartVersion();
    void test_headerPathFilter_builtin();
    void test_headerPathFilter_system();
    void test_headerPathFilter_user();
    void test_headerPathFilter_noProjectPathSet();
    void test_headerPathFilter_dontAddInvalidPath();
    void test_headerPathFilter_clangHeadersPath();
    void test_headerPathFilter_clangHeadersPathWitoutClangVersion();
    void test_headerPathFilter_clangHeadersAndCppIncludesPathsOrderMacOs();
    void test_headerPathFilter_clangHeadersAndCppIncludesPathsOrderLinux();
    void test_headerPathFilter_removeGccInternalPaths();
    void test_headerPathFilter_removeGccInternalPathsExceptForStandardPaths();
    void test_headerPathFilter_clangHeadersAndCppIncludesPathsOrderNoVersion();
    void test_headerPathFilter_clangHeadersAndCppIncludesPathsOrderAndroidClang();
#endif

private:
    CppFileSettings *fileSettings();
    class CppToolsPluginPrivate *d = nullptr;
};

} // namespace Internal
} // namespace CppTools