File indexing completed on 2024-05-05 04:39:26

 /*
     SPDX-FileCopyrightText: 2009 Andreas Pakulat <apaku@gmx.de>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef CMAKEUTILS_H
 #define CMAKEUTILS_H
 
 #include "cmakecommonexport.h"
 
 #include <QStringList>
 #include <util/path.h>
 #include <QStandardPaths>
 
 namespace KDevelop
 {
     class ProjectBaseItem;
     class IProject;
     class Path;
 }
 
 struct CMakeTest;
 class ICMakeDocumentation;
 class CMakeCacheModel;
 
 template <typename T, typename Q, typename W>
 static T kTransform(const Q& list, W func)
 {
     T ret;
     ret.reserve(list.size());
     for (auto it = list.constBegin(), itEnd = list.constEnd(); it!=itEnd; ++it)
         ret += func(*it);
     return ret;
 }
 
 template <typename Q, typename W>
 static int kIndexOf(const Q& list, W func)
 {
     int i = 0;
     for (auto it = list.constBegin(), itEnd = list.constEnd(); it!=itEnd; ++it) {
         if (func(*it))
             return i;
         ++i;
     }
     return -1;
 }
 
 template <typename T, typename Q, typename _UnaryOperation>
 static T kFilter(const Q &input, _UnaryOperation op)
 {
     T ret;
     for(const auto& v : input) {
         if (op(v))
             ret += v;
     }
     return ret;
 }
 
 namespace CMake
 {
     /**
      * Checks whether there's a need to run cmake for the given project item
      * This is the case if no builddir has been specified, in which case
      * it asks for one.
      *
      * @returns true if configure should be run, false otherwise
      */
     KDEVCMAKECOMMON_EXPORT bool checkForNeedingConfigure( KDevelop::IProject* project );
 
     /**
      * @returns the current builddir for the given project or an empty url if none
      * has been set by the user.
      */
     KDEVCMAKECOMMON_EXPORT KDevelop::Path currentBuildDir( KDevelop::IProject* project, int builddir = -1 );
 
     /**
      * @returns the path to the 'compile_commands.json' file in the current builddir for the given project
      * or an empty url if none has been set by the user.
      */
     KDEVCMAKECOMMON_EXPORT KDevelop::Path commandsFile( KDevelop::IProject* project );
     /**
      * @returns the path to the 'CMakeFiles/TargetDirectories.txt' file in the current builddir for the given project
      * or an empty url if none has been set by the user.
      */
     KDEVCMAKECOMMON_EXPORT KDevelop::Path targetDirectoriesFile( KDevelop::IProject* project );
 
     /**
      * @returns the current build type for the given project or "Release" as default value.
      */
     KDEVCMAKECOMMON_EXPORT QString currentBuildType( KDevelop::IProject* project, int builddir = -1 );
 
     /**
     * @returns the CMake executable, taking into account standard
     * installation dirs on Windows, or empty string in case of failure.
     */
     KDEVCMAKECOMMON_EXPORT QString findExecutable();
     /**
      * @returns the current CMake executable for the given project, falling back to
      * CMakeBuilderSettings::self()->cmakeExecutable() as the user-specified KDevelop-wide default value. 
      */
     KDEVCMAKECOMMON_EXPORT KDevelop::Path currentCMakeExecutable(KDevelop::IProject* project, int builddir = -1);
 
     /**
      * @returns the version string reported by the given CMake executable
      */
     KDEVCMAKECOMMON_EXPORT QString cmakeExecutableVersion(const QString& cmakeExecutable);
 
     /**
      * @returns the current install dir for the given project or an empty string if none has been defined
      * (in that case, whatever default CMake sets for the platform will be used.)
      */
     KDEVCMAKECOMMON_EXPORT KDevelop::Path currentInstallDir( KDevelop::IProject* project, int builddir = -1 );
     
     /**
      * @returns the current extra arguments for the given project or "" as default value.
      */
     KDEVCMAKECOMMON_EXPORT QString currentExtraArguments( KDevelop::IProject* project, int builddir = -1 );
 
     /**
      * @returns the current build dir for the given project.
      */
     KDEVCMAKECOMMON_EXPORT QString projectRootRelative( KDevelop::IProject* project );
     
     /**
      * @returns whether there's projectRootRelative defined
      */
     KDEVCMAKECOMMON_EXPORT bool hasProjectRootRelative( KDevelop::IProject* project );
     
     /**
     * Extracts target names from builddir/CMakeFiles/TargetDirectories.txt and maps corresponding source locations to them.
     */
 
     KDEVCMAKECOMMON_EXPORT QHash<KDevelop::Path, QStringList> enumerateTargets(const KDevelop::Path& targetsFilePath, const QString& sourceDir, const KDevelop::Path &buildDir);
     /**
      * Convenience function to get the project root.
      */
     KDEVCMAKECOMMON_EXPORT KDevelop::Path projectRoot( KDevelop::IProject* project );
     
     /**
      * @returns the environment configuration for a @p project
      */
     KDEVCMAKECOMMON_EXPORT QString currentEnvironment( KDevelop::IProject* project, int builddir = -1 );
 
     /**
      * Sets the current install dir for the given project.
      */
     KDEVCMAKECOMMON_EXPORT void setCurrentInstallDir( KDevelop::IProject* project, const KDevelop::Path &path );
 
     /**
      * Sets the current build type for the given project.
      */
     KDEVCMAKECOMMON_EXPORT void setCurrentBuildType( KDevelop::IProject* project, const QString& type );
 
      /**
      * Sets the current CMake executable for the given project.
      */
     KDEVCMAKECOMMON_EXPORT void setCurrentCMakeExecutable(KDevelop::IProject* project, const KDevelop::Path& path);
 
     /**
      * Sets the current build dir for the given project.
      */
     KDEVCMAKECOMMON_EXPORT void setCurrentBuildDir( KDevelop::IProject* project, const KDevelop::Path& path );
     
     /**
      * Sets the current build dir for the given project.
      */
     KDEVCMAKECOMMON_EXPORT void setProjectRootRelative( KDevelop::IProject* project, const QString& path);
     
     /**
      * Sets the current extra arguments for the given project.
      */
     KDEVCMAKECOMMON_EXPORT void setCurrentExtraArguments( KDevelop::IProject* project, const QString& args );
 
     /**
      * Obtains a cmake documentation instance if it exists
      */
     KDEVCMAKECOMMON_EXPORT ICMakeDocumentation* cmakeDocumentation();
     
     /**
      * Retrieves the configured build directories for @p project.
      */
     KDEVCMAKECOMMON_EXPORT QStringList allBuildDirs(KDevelop::IProject* project);
 
     /**
      * Attempts to update CMake configuration keys from the cache data (CMakeCache.txt)
      *
      * The model is created based on build directory path for the given index @p buildDirectory
      */
     KDEVCMAKECOMMON_EXPORT void updateConfig( KDevelop::IProject* project, int buildDirectory);
 
     /**
      * Returns the current build directory count.
      */
     KDEVCMAKECOMMON_EXPORT int buildDirCount( KDevelop::IProject* project );
 
     /**
      * Sets the build directory count (equivalent to adding a new build directory).
      */
     KDEVCMAKECOMMON_EXPORT void setBuildDirCount( KDevelop::IProject* project, int count );
 
     /**
      * @returns the current builddir index for the given project or -1 if none
      * has been set by the user.
      */
     KDEVCMAKECOMMON_EXPORT int currentBuildDirIndex( KDevelop::IProject *project );
 
     /**
      * Sets the current build dir index for the given project.
      */
     KDEVCMAKECOMMON_EXPORT void setCurrentBuildDirIndex( KDevelop::IProject* project, int buildDirIndex );
 
     /**
      * A hack to avoid adding an optional "build directory index" parameter to all functions here.
      * This function sets an alternate build directory index key that overrides regular build directory index.
      */
     KDEVCMAKECOMMON_EXPORT void setOverrideBuildDirIndex( KDevelop::IProject* project, int overrideBuildDirIndex );
 
     /**
      * This removes build directory override key (\ref setOverrideBuildDirIndex).
      * Silently returns if there is no override.
      *
      * @param writeToMainIndex Whether the overridden index should be saved to regular
      */
     KDEVCMAKECOMMON_EXPORT void removeOverrideBuildDirIndex( KDevelop::IProject* project, bool writeToMainIndex = false );
 
     /**
      * Sets the environment configuration for the given project.
      */
     KDEVCMAKECOMMON_EXPORT void setCurrentEnvironment( KDevelop::IProject* project, const QString& environment );
 
     /**
      * Removes current build directory (overridden or not) from the project configuration.
      * Override is then cleared and index set to -1.
      */
     KDEVCMAKECOMMON_EXPORT void removeBuildDirConfig( KDevelop::IProject* project );
 
     KDEVCMAKECOMMON_EXPORT KDevelop::Path::List resolveSystemDirs(KDevelop::IProject* project, const QStringList& dirs);
 
     /** Runs the process specified by @p execName with @p args */
     KDEVCMAKECOMMON_EXPORT QString executeProcess(const QString& execName, const QStringList& args=QStringList());
 
     /** Opens @p cmakeCachePath and parses it, returns a hash with the specified keys in @p variables */
     KDEVCMAKECOMMON_EXPORT QHash<QString, QString> readCacheValues(const KDevelop::Path& cmakeCachePath, QSet<QString> variables);
 
     KDEVCMAKECOMMON_EXPORT QStringList supportedGenerators();
 
     KDEVCMAKECOMMON_EXPORT QString defaultGenerator();
 
     KDEVCMAKECOMMON_EXPORT QVector<CMakeTest> importTestSuites(const KDevelop::Path &buildDir);
 }
 
 #endif