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
|
/* This file is part of the KDE project
Copyright (C) 2002 Bernd Gehrmann <bernd@tdevelop.org>
This library 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 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 _FILETEMPLATE_H_
#define _FILETEMPLATE_H_
#include <tqstring.h>
class KDevPlugin;
class TQDomDocument;
/**
@file filetemplate.h
FileTemplate class with utility methods to work with file templates.
*/
/**
Utilities to work with file templates in the current project.
*/
class FileTemplate
{
public:
/**Policy of finding file templates.*/
typedef enum {
Default /**<Checks for templates in project and also for global filecreate templates.*/,
Custom /**<Checks for templates in custom directories. This usually means that
full paths are given for FileTemplate methods.*/
} Policy;
/**
* @return Whether a template with the given name
* exists in the current project. File templates
* are stored in the "templates" subdirectory of a project or in application shared dirs.
*/
static bool exists(KDevPlugin *part, const TQString &name, Policy p = Default);
/**
* Reads a template with the given name (e.g. "cpp")
* and makes variable substitutions (like $AUTHOR$ etc.)
* in it. The resulting string is returned.
*/
static TQString read(KDevPlugin *part, const TQString &name, Policy p = Default);
/**
* Reads a template with the given URL
* and makes variable substitutions (like $AUTHOR$ etc.)
* in it. The resulting string is returned.
*/
static TQString readFile(KDevPlugin *part, const TQString &fileName);
/**
* Makes variable substitutions on a text, based on a specified TQDomDocument
* describing a KDevelop project file. The resulting string is returned.
*/
static TQString makeSubstitutions(TQDomDocument &dom, const TQString &text);
/**
* Copies a file template with the given name to the
* file with the name dest and - while copying -
* performs variable substitutions.
*/
static bool copy(KDevPlugin *part, const TQString &name,
const TQString &dest, Policy p = Default);
/**
* Translates a template name into a full path, or suggests a full path
* for the template in the project directory if it doesn't exist.
*/
static TQString fullPathForName(KDevPlugin *part, const TQString &name, Policy p = Default);
};
#endif
|
