1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/***************************************************************************
Copyright 2006 David Nolden <david.nolden.kdevelop@art-master.de>
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef INCLUDEPATHRESOLVER_H
#define INCLUDEPATHRESOLVER_H
#include <QString>
#include <QStringList>
#include <language/editor/modificationrevisionset.h>
class KUrl;
class QDir;
class QFile;
namespace CppTools {
class FileModificationTimeWrapper;
struct PathResolutionResult
{
PathResolutionResult(bool success = false, const QString& errorMessage = QString(), const QString& longErrorMessage = QString())
: success(success)
, errorMessage(errorMessage)
, longErrorMessage(longErrorMessage)
{
}
bool success;
QString errorMessage;
QString longErrorMessage;
KDevelop::ModificationRevisionSet includePathDependency;
QStringList paths;
void addPathsUnique(const PathResolutionResult& rhs)
{
foreach(const QString& path, rhs.paths) {
if(!paths.contains(path))
paths.append(path);
}
includePathDependency += rhs.includePathDependency;
}
operator bool() const
{
return success;
}
};
struct CustomIncludePathsSettings
{
QString storagePath; //Directory the custom file is in
QString sourceDir;
QString buildDir;
QStringList paths;
QString storageFile() const;
bool isValid() const ;
static CustomIncludePathsSettings read(const QString& storagePath);
///Finds a valid storage file above the given start path that contains custom include paht settings
///If no valid storage file is found, returns an empty string
static QString find(const QString& startPath);
///Finds a storage-path for the given start path, and reads the custom include path settings
///If none were found, returns an invalid item
static CustomIncludePathsSettings findAndRead(const QString& startPath);
///Same as findAndRead, but also convert all relative paths into absolute ones from the
///storage path.
static CustomIncludePathsSettings findAndReadAbsolute(const QString& startPath);
//Stores these settings exclusively, overwriting any old ones for the storage path
bool write();
//Deletes these settings
bool delete_();
};
class SourcePathInformation;
///One resolution-try can issue up to 4 make-calls in worst case
class IncludePathResolver
{
public:
IncludePathResolver();
///Same as below, but uses the directory of the file as working-directory. The argument must be absolute.
PathResolutionResult resolveIncludePath( const QString& file );
///The include-path is only computed once for a whole directory, then it is cached using the modification-time of the Makefile.
PathResolutionResult resolveIncludePath( const QString& file, const QString& workingDirectory, int maxStepsUp = 20 );
///source and build must be absolute paths
void setOutOfSourceBuildSystem( const QString& source, const QString& build );
///resets to in-source build system
void resetOutOfSourceBuild();
static void clearCache();
KDevelop::ModificationRevisionSet findIncludePathDependency(const QString& file);
void enableMakeResolution(bool enable);
private:
bool m_isResolving;
bool m_outOfSource;
bool m_enableMakeResolution;
KUrl mapToBuild(const KUrl& url);
///Executes the command using KProcess
bool executeCommand( const QString& command, const QString& workingDirectory, QString& result ) const;
///file should be the name of the target, without extension(because that may be different)
PathResolutionResult resolveIncludePathInternal( const QString& file, const QString& workingDirectory,
const QString& makeParameters, const SourcePathInformation& source, int maxDepth );
QString m_source;
QString m_build;
};
}
#endif
|
