summaryrefslogtreecommitdiffstats
path: root/kate/part/katefactory.h
blob: a01e3a32caf5d8ac4424d24b32535361bc23fc3f (plain)
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
/* This file is part of the KDE libraries
   Copyright (C) 2001-2004 Christoph Cullmann <cullmann@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef __KATE_FACTORY_H__
#define __KATE_FACTORY_H__

#include "katejscript.h"
#include <tdeparts/factory.h>

#include <ktrader.h>
#include <kinstance.h>
#include <kaboutdata.h>

// katepart version must be a string in double quotes, format: "x.x"
#define KATEPART_VERSION "2.5"

class KateCmd;
class KateFileTypeManager;
class KateSchemaManager;
class KateDocumentConfig;
class KateViewConfig;
class KateRendererConfig;
class KateDocument;
class KateRenderer;
class KateView;
class KateJScript;
class KateJScriptManager;
class KateIndentScriptManagerAbstract;
class KDirWatch;
class KVMAllocator;

namespace Kate {
  class Command;
}


class KateFactory
{
  private:
    /**
     * Default constructor, private, as singleton
     */
    KateFactory ();

  public:
    /**
     * Destructor
     */
    ~KateFactory ();

    /**
     * singleton accessor
     * @return instance of the factory
     */
    static KateFactory *self ();

    /**
     * reimplemented create object method
     * @param parentWidget parent widget
     * @param widgetName widget name
     * @param parent TQObject parent
     * @param name object name
     * @param classname class parent
     * @param args additional arguments
     * @return constructed part object
     */
    KParts::Part *createPartObject ( TQWidget *parentWidget, const char *widgetName,
                                     TQObject *parent, const char *name, const char *classname,
                                     const TQStringList &args );

    /**
     * public accessor to the instance
     * @return instance
     */
    inline TDEInstance *instance () { return &m_instance; };

    /**
     * register document at the factory
     * this allows us to loop over all docs for example on config changes
     * @param doc document to register
     */
    void registerDocument ( KateDocument *doc );

    /**
     * unregister document at the factory
     * @param doc document to register
     */
    void deregisterDocument ( KateDocument *doc );

    /**
     * register view at the factory
     * this allows us to loop over all views for example on config changes
     * @param view view to register
     */
    void registerView ( KateView *view );

    /**
     * unregister view at the factory
     * @param view view to unregister
     */
    void deregisterView ( KateView *view );

     /**
     * register renderer at the factory
     * this allows us to loop over all views for example on config changes
     * @param renderer renderer to register
     */
    void registerRenderer ( KateRenderer  *renderer );

    /**
     * unregister renderer at the factory
     * @param renderer renderer to unregister
     */
    void deregisterRenderer ( KateRenderer  *renderer );

    /**
     * return a list of all registered docs
     * @return all known documents
     */
    inline TQPtrList<KateDocument> *documents () { return &m_documents; };

    /**
     * return a list of all registered views
     * @return all known views
     */
    inline TQPtrList<KateView> *views () { return &m_views; };

    /**
     * return a list of all registered renderers
     * @return all known renderers
     */
    inline TQPtrList<KateRenderer> *renderers () { return &m_renderers; };

    /**
     * on start detected plugins
     * @return list of all at launch detected tdetexteditor::plugins
     */
    inline const KTrader::OfferList &plugins () { return m_plugins; };

    /**
     * global dirwatch
     * @return dirwatch instance
     */
    inline KDirWatch *dirWatch () { return m_dirWatch; };

    /**
     * global filetype manager
     * used to manage the file types centrally
     * @return filetype manager
     */
    inline KateFileTypeManager *fileTypeManager () { return m_fileTypeManager; };

    /**
     * manager for the katepart schemas
     * @return schema manager
     */
    inline KateSchemaManager *schemaManager () { return m_schemaManager; };

    /**
     * fallback document config
     * @return default config for all documents
     */
    inline KateDocumentConfig *documentConfig () { return m_documentConfig; }

    /**
     * fallback view config
     * @return default config for all views
     */
    inline KateViewConfig *viewConfig () { return m_viewConfig; }

    /**
     * fallback renderer config
     * @return default config for all renderers
     */
    inline KateRendererConfig *rendererConfig () { return m_rendererConfig; }

    /**
     * Global allocator for swapping
     * @return allocator
     */
    inline KVMAllocator *vm () { return m_vm; }

    /**
     * global interpreter, for nice js stuff
     */
    KateJScript *jscript ();

    /**
     * Global javascript collection
     */
    KateJScriptManager *jscriptManager () { return m_jscriptManager; }


    /**
     * looks up a script given by name. If there are more than
     * one matching, the first found will be taken
     */
    KateIndentScript indentScript (const TQString &scriptname);

  private:
    /**
     * instance of this factory
     */
    static KateFactory *s_self;

    /**
     * about data (authors and more)
     */
    TDEAboutData m_aboutData;

    /**
     * our kinstance
     */
    TDEInstance m_instance;

    /**
     * registered docs
     */
    TQPtrList<KateDocument> m_documents;

    /**
     * registered views
     */
    TQPtrList<KateView> m_views;

    /**
     * registered renderers
     */
    TQPtrList<KateRenderer> m_renderers;

    /**
     * global dirwatch object
     */
    KDirWatch *m_dirWatch;

    /**
     * filetype manager
     */
    KateFileTypeManager *m_fileTypeManager;

    /**
     * schema manager
     */
    KateSchemaManager *m_schemaManager;

    /**
     * at start found plugins
     */
    KTrader::OfferList m_plugins;

    /**
     * fallback document config
     */
    KateDocumentConfig *m_documentConfig;

    /**
     * fallback view config
     */
    KateViewConfig *m_viewConfig;

    /**
     * fallback renderer config
     */
    KateRendererConfig *m_rendererConfig;

    /**
     * vm allocator
     */
    KVMAllocator *m_vm;

    /**
     * internal commands
     */
    TQValueList<Kate::Command *> m_cmds;

    /**
     * js interpreter
     */
    KateJScript *m_jscript;


    /**
     * js script manager
     */
    KateJScriptManager *m_jscriptManager;


    /**
     * manager for js based indenters
     */
    TQPtrList<KateIndentScriptManagerAbstract> m_indentScriptManagers;

};

#endif

// kate: space-indent on; indent-width 2; replace-tabs on;