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
|
/*
SPDX-FileCopyrightText: 2011 Yannick Motta <yannick.motta@gmail.com>
SPDX-FileCopyrightText: 2011 Martin Heide <martin.heide@gmx.net>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KDEVPLATFORM_IBUDDYDOCUMENTFINDER_H
#define KDEVPLATFORM_IBUDDYDOCUMENTFINDER_H
#include <QVector>
#include <QUrl>
#include "interfacesexport.h"
namespace KDevelop {
/**
* @short Implement this to add buddy document functionality to your language plugin.
*
* It enables the DocumentController (shell) to find related documents
* (normally declaration/definition files, like foo.h and foo.cpp).
* The DocumentController will position tabs of buddy documents next to
* each other if the option UISettings.TabBarArrangeBuddies is 1.
* The implementation also determines the order of the tabs in the tabbar.
*
* For finding a buddy document, the DocumentController addresses the
* IBuddyDocumentFinder object that is registerd for this mimetype:
*
* This class provides static "registry" functions to handle a specific buddy finding
* method (i.e. an object of class IBuddyDocumentFinder) for different
* mimetypes. Like this, you can have for example an IBuddyDocumentFinder
* for C++ files which considers foo.cpp and foo.h as buddies, and an
* IBuddyDocumentFinder for Ada files which considers bar.adb and bar.ads as
* buddies.
* Like this, the concept of buddy documents is extensible for every language
* for which support is added to KDevelop.
*
* If you want to add IBuddyDocumentFinder functionality to your language
* plugin, your main class will inherit from IBuddyDocumentFinder (or have an
* attribute of this type). Then in your constructor, call
* @code addFinder(mimetype, this) @endcode
* for each mimetype that your plugin supports. It is no problem to register the
* same IBuddyDocumentFinder for several mimetypes.
*
* In the same way, in your destructor, you'll call
* @code removeFinder(mimetype, this) @endcode
* for each supported mimetype, to avoid that your IBuddyDocumentFinder object
* is used beyond its lifetime.
*
* After you have registered it, your IBuddyDocumentFinder implementation will be found by
* @code finderForMimeType(mimetype) @endcode
* For example, the shell's DocumentController calls this function with idoc->mimeType()
* in order to find a buddy document of a particular IDocument *idoc.
*/
class KDEVPLATFORMINTERFACES_EXPORT IBuddyDocumentFinder
{
public:
virtual ~IBuddyDocumentFinder(){}
/**
* Called to determine if two document URLs should be considered as related.
*
* @return true, if the two documents are buddies.
* For example, a C++ implementation would return true for
* areBuddies(QUrl::fromLocalFile("...../foo.h"), QUrl::fromLocalFile("...../foo.cpp")).
*/
virtual bool areBuddies(const QUrl& url1, const QUrl& url2) = 0;
/**
* @brief Called to determine the order of two documents in the tabbar.
*
* Example: a C++ implementation that wants to place the tab of the .h
* file left of the .cpp tab must return true for <br>
* <i>buddyOrder(QUrl::fromLocalFile("foo.h"), QUrl::fromLocalFile("foo.cpp"))</i><br>
* and false for <br>
* <i>buddyOrder(QUrl::fromLocalFile("foo.cpp"), QUrl::fromLocalFile("foo.h"))</i>
*
* accepts two documents which are buddies,
* this means areBuddies(url1,url2) returned true.
* @return true if url1's tab should be placed left of url2's tab and
* false for the inverse.
*/
virtual bool buddyOrder(const QUrl& url1, const QUrl& url2) = 0;
/**
* Returns a list of QUrls of potential buddies of the document
* provided by @p url.
*
* The urls are potential buddies and it is not ensured that the files
* really exist.
*
* @returns list of potential buddy documents or an empty list
* if non are available.
*/
virtual QVector<QUrl> potentialBuddies(const QUrl& url) const = 0;
/**
* @brief Registers a <i>IBuddyDocumentFinder</i> object for a mimetype.
*
* @details To be called in the constructor of language plugins.
* Afterwards, finderForMimeType( @p mimeType ) will return @p finder ,
* as long as the entry is not overwritten by another call to addFinder.
*/
static void addFinder(const QString& mimeType, IBuddyDocumentFinder* finder);
/**
* @brief Un-registers a <i>IBuddyDocumentFinder</i> object for a mimetype.
*
* @details To be called in the destructor of language plugins.
* Afterwards, finderForMimeType( @p mimeType ) will return 0, until a new
* entry for this mimetype is created by addFinder().
*/
static void removeFinder(const QString& mimeType);
/**
* Returns the registered IBuddyDocumentFinder for this mimetype, or 0.
*
* Used in the DocumentController (shell).
*/
static IBuddyDocumentFinder* finderForMimeType(const QString& mimeType);
};
}
#endif
|
