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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/*
* This file is part of KDevelop
*
* Copyright 2006 Adam Treat <treat@kde.org>
* Copyright 2006-2008 Hamish Rodda <rodda@kde.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the
* Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef PARSEJOB_H
#define PARSEJOB_H
#include <QtCore/QWeakPointer>
#include <KDE/KUrl>
#include <threadweaver/JobSequence.h>
#include "../duchain/indexedstring.h"
#include <language/duchain/topducontext.h>
#include <language/editor/modificationrevision.h>
namespace KDevelop
{
class BackgroundParser;
class TopDUContext;
class ReferencedTopDUContext;
/**
* The base class for background parser jobs.
*
* In your language plugin, don't forget to use acquire an UrlParseLock before starting to the actual parsing.
*/
class KDEVPLATFORMLANGUAGE_EXPORT ParseJob : public ThreadWeaver::JobSequence
{
Q_OBJECT
public:
ParseJob( const KUrl &url );
/**
* _No_ mutexes/locks are allowed to be locked when this object is destroyed (except for optionally the foreground lock)
* */
virtual ~ParseJob();
struct Contents {
// Modification-time of the read content
ModificationRevision modification;
// The contents in utf-8 format
QByteArray contents;
};
/**
* _No_ mutexes/locks are allowed to be locked when this is called (except for optionally the foreground lock)
*
* Locks the document revision so that mapping from/to the revision in the editor using MovingInterface will be possible.
*
* Returns an invalid pointer if the call succeeds, and a valid one if the reading fails.
* */
KDevelop::ProblemPointer readContents();
/**
* After reading the contents, you can call this to retrieve it.
* */
const Contents& contents() const;
/**
* Translates the given context from its previous revision to the revision that has
* been retrieved during readContents(). The top-context meta-data will be updated
* with the revision.
*
* This can be done after reading the context before updating, so
* that the correct ranges are matched onto each other during the update.
*
* _No_ mutexes/locks are allowed to be locked when this is called (except for optionally the foreground lock)
*/
void translateDUChainToRevision(TopDUContext* context);
/// \returns the indexed url of the document to be parsed.
Q_SCRIPTABLE KDevelop::IndexedString document() const;
/**
* Sets a list of QObjects that should contain a slot
* "void updateReady(KDevelop::IndexedString url, KDevelop::ReferencedTopDUContext topContext)".
* The notification is guaranteed to be called once the parse-job finishes, from within its destructor.
* The given top-context may be invalid if the update failed.
*/
Q_SCRIPTABLE void setNotifyWhenReady(QList<QWeakPointer<QObject> > notify);
/// Sets the du-context that was created by this parse-job
Q_SCRIPTABLE virtual void setDuChain(ReferencedTopDUContext duChain);
/// Returns the set du-context, or zero of none was set.
Q_SCRIPTABLE virtual ReferencedTopDUContext duChain() const;
/// Overridden to allow jobs to determine if they've been requested to abort
Q_SCRIPTABLE virtual void requestAbort();
/// Determine if the job has been requested to abort
Q_SCRIPTABLE bool abortRequested() const;
/// Sets success to false, causing failed() to be emitted
Q_SCRIPTABLE void abortJob();
/// Overridden to convey whether the job succeeded or not.
Q_SCRIPTABLE virtual bool success() const;
/// Set the minimum features the resulting top-context should have
Q_SCRIPTABLE void setMinimumFeatures(TopDUContext::Features features);
/// Minimum set of features the resulting top-context should have
Q_SCRIPTABLE TopDUContext::Features minimumFeatures() const;
/// Allows statically specifying an amount of features required for an url.
/// These features will automatically be or'ed with the minimumFeatures() returned
/// by any ParseJob with the given url.
/// Since this causes some additional complixity in update-checking, minimum features should not
/// be set permanently.
static void setStaticMinimumFeatures(IndexedString url, TopDUContext::Features features);
/// Must be called exactly once for each call to setStaticMinimumFeatures, with the same features.
static void unsetStaticMinimumFeatures(IndexedString url, TopDUContext::Features features);
/// Returns the statically set minimum features for the given url, or zero.
static TopDUContext::Features staticMinimumFeatures(IndexedString url);
/// Returns whether there is minimum features set up for some url
static bool hasStaticMinimumFeatures();
Q_SIGNALS:
/**Can be used to give progress feedback to the background-parser. @param value should be between 0 and 1, where 0 = 0% and 1 = 100%
* @param text may be a text that describes the current state of parsing
* Do not trigger this too often, for performance reasons. */
void progress(KDevelop::ParseJob*, float value, QString text);
private:
class ParseJobPrivate* const d;
};
}
#endif
|
