Changeset View
Changeset View
Standalone View
Standalone View
plugins/cmake/cmakeutils.h
| Show First 20 Lines • Show All 80 Lines • ▼ Show 20 Line(s) | 75 | { | |||
|---|---|---|---|---|---|
| 81 | * @returns true if configure should be run, false otherwise | 81 | * @returns true if configure should be run, false otherwise | ||
| 82 | */ | 82 | */ | ||
| 83 | KDEVCMAKECOMMON_EXPORT bool checkForNeedingConfigure( KDevelop::IProject* project ); | 83 | KDEVCMAKECOMMON_EXPORT bool checkForNeedingConfigure( KDevelop::IProject* project ); | ||
| 84 | 84 | | |||
| 85 | /** | 85 | /** | ||
| 86 | * @returns the current builddir for the given project or an empty url if none | 86 | * @returns the current builddir for the given project or an empty url if none | ||
| 87 | * has been set by the user. | 87 | * has been set by the user. | ||
| 88 | */ | 88 | */ | ||
| 89 | KDEVCMAKECOMMON_EXPORT KDevelop::Path currentBuildDir( KDevelop::IProject* project, int builddir = -1 ); | 89 | KDEVCMAKECOMMON_EXPORT KDevelop::Path currentBuildDir( KDevelop::IProject* project, bool canonical=false, int builddir = -1 ); | ||
| 90 | 90 | | |||
| 91 | /** | 91 | /** | ||
| 92 | * @returns the path to the 'compile_commands.json' file in the current builddir for the given project | 92 | * @returns the path to the 'compile_commands.json' file in the current builddir for the given project | ||
| 93 | * or an empty url if none has been set by the user. | 93 | * or an empty url if none has been set by the user. | ||
| 94 | */ | 94 | */ | ||
| 95 | KDEVCMAKECOMMON_EXPORT KDevelop::Path commandsFile( KDevelop::IProject* project ); | 95 | KDEVCMAKECOMMON_EXPORT KDevelop::Path commandsFile( KDevelop::IProject* project ); | ||
mwolff: When should this function be used instead of the above? Shouldn't the above always return the… | |||||
| 96 | /** | 96 | /** | ||
| 97 | * @returns the path to the 'CMakeFiles/TargetDirectories.txt' file in the current builddir for the given project | 97 | * @returns the path to the 'CMakeFiles/TargetDirectories.txt' file in the current builddir for the given project | ||
| 98 | * or an empty url if none has been set by the user. | 98 | * or an empty url if none has been set by the user. | ||
| 99 | */ | 99 | */ | ||
| 100 | KDEVCMAKECOMMON_EXPORT KDevelop::Path targetDirectoriesFile( KDevelop::IProject* project ); | 100 | KDEVCMAKECOMMON_EXPORT KDevelop::Path targetDirectoriesFile( KDevelop::IProject* project ); | ||
| 101 | 101 | | |||
| 102 | /** | 102 | /** | ||
| 103 | * @returns the current build type for the given project or "Release" as default value. | 103 | * @returns the current build type for the given project or "Release" as default value. | ||
| ▲ Show 20 Lines • Show All 79 Lines • ▼ Show 20 Line(s) | |||||
| 183 | /** | 183 | /** | ||
| 184 | * Obtains a cmake documentation instance if it exists | 184 | * Obtains a cmake documentation instance if it exists | ||
| 185 | */ | 185 | */ | ||
| 186 | KDEVCMAKECOMMON_EXPORT ICMakeDocumentation* cmakeDocumentation(); | 186 | KDEVCMAKECOMMON_EXPORT ICMakeDocumentation* cmakeDocumentation(); | ||
| 187 | 187 | | |||
| 188 | /** | 188 | /** | ||
| 189 | * Retrieves the configured build directories for @p project. | 189 | * Retrieves the configured build directories for @p project. | ||
| 190 | */ | 190 | */ | ||
| 191 | KDEVCMAKECOMMON_EXPORT QStringList allBuildDirs(KDevelop::IProject* project); | 191 | KDEVCMAKECOMMON_EXPORT QStringList allBuildDirs(KDevelop::IProject* project, bool canonical=false); | ||
| 192 | 192 | | |||
| 193 | /** | 193 | /** | ||
| 194 | * Attempts to migrate the CMake configuration to per-builddir format. | 194 | * Attempts to migrate the CMake configuration to per-builddir format. | ||
| 195 | * Silently returns if the migration has already been performed. | 195 | * Silently returns if the migration has already been performed. | ||
| 196 | */ | 196 | */ | ||
mwolff: same as above | |||||
| 197 | KDEVCMAKECOMMON_EXPORT void attemptMigrate( KDevelop::IProject* project ); | 197 | KDEVCMAKECOMMON_EXPORT void attemptMigrate( KDevelop::IProject* project ); | ||
| 198 | 198 | | |||
| 199 | /** | 199 | /** | ||
| 200 | * Attempts to update CMake configuration keys from the cache data (CMakeCache.txt) | 200 | * Attempts to update CMake configuration keys from the cache data (CMakeCache.txt) | ||
| 201 | * | 201 | * | ||
| 202 | * The model is created based on build directory path for the given index @p buildDirectory | 202 | * The model is created based on build directory path for the given index @p buildDirectory | ||
| 203 | */ | 203 | */ | ||
| 204 | KDEVCMAKECOMMON_EXPORT void updateConfig( KDevelop::IProject* project, int buildDirectory); | 204 | KDEVCMAKECOMMON_EXPORT void updateConfig( KDevelop::IProject* project, int buildDirectory); | ||
| ▲ Show 20 Lines • Show All 63 Lines • Show Last 20 Lines | |||||
When should this function be used instead of the above? Shouldn't the above always return the canonical version?