blob: 4a8da4e3c65748d93608dc0a01d31226b714f1e9 (
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
|
/*
**************************************************************************
description
--------------------
copyright : (C) 2003 by Luis Carvalho
email : [email protected]
**************************************************************************
**************************************************************************
* *
* 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 PMLIBRARYHANDLE_H
#define PMLIBRARYHANDLE_H
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <tqstring.h>
#include <tqdict.h>
class TQDomElement;
/**
* Class that holds all the information about a specific library.
* The class can also create the library if it doesn't exists.
*
* A library is nothing more than a directory in the file system, and
* an index file stored in XML format.
*
* One library can have one or more sub-libraries. Sub-libraries can
* only contain the entries of object files and more sub-libraries.
*
*/
class PMLibraryHandle
{
public:
enum PMResult { Ok, CouldNotCreateDir, ExistingDir,
CouldNotCreateInfo, ReadOnlyLib,
CouldNotCreateFile, NotInLib };
/**
* Iterator for the objects in the library
*/
typedef TQDictIterator<TQString> EntryIterator;
/**
* Constructor for an empty library
*/
PMLibraryHandle( );
/**
* Constructor for a given directory.
*/
PMLibraryHandle( const TQString& path );
/**
* Destructor
*/
~PMLibraryHandle( );
/**
* Returns the library's name
*/
TQString name( ) const { return m_name; }
/**
* Returns the library's path
*/
TQString path( ) const { return m_path; }
/**
* Returns the library's author
*/
TQString author( ) const { return m_author; }
/**
* Returns the library's description
*/
TQString description( ) const { return m_description; }
/**
* Sets the library's name
*/
void setName( const TQString& name );
/**
* Sets the library's path
*/
void setPath( const TQString& path );
/**
* Sets the library's author
*/
void setAuthor( const TQString& author );
/**
* Sets the library's description
*/
void setDescription( const TQString& description );
/**
* Sets the library's erad only status
*/
void setReadOnly( const bool rdonly = true );
/**
* Save the library's information file.
*/
PMLibraryHandle::PMResult saveLibraryInfo( );
/**
* Create the library's information file.
*/
PMLibraryHandle::PMResult createLibrary( );
/**
* Append a new object to the library.
* Returns PMLibraryHandle::Ok if successful or the reason of failure.
*/
PMLibraryHandle::PMResult createNewObject( );
/**
* Adds an already existing object to the library
* @param path The path for the object
* @param name The name of the object
* @return PMLibraryHandle::Ok if successful or the reason of failure
*/
PMLibraryHandle::PMResult addObject( const TQString& path, const TQString& name );
/**
* Deletes an object out of the library. Only removes the entry from the library
* doesn't delete the objects file
* @param objectName The name of the object ( or objects path ) to delete
* @return PMLibraryHandle::Ok if successul or the reason of failure
*/
PMLibraryHandle::PMResult deleteObject( const TQString& objectName );
/**
* Create a new sub library.
*/
PMLibraryHandle::PMResult createNewSubLibrary( const TQString subLibName );
/**
* Adds an already existing sub-library to the library
* @param path The path for the sub library
* @param subLibName The name of the sub library
* @return PMLibraryHandle::Ok if successful or the reason of failure
*/
PMLibraryHandle::PMResult addSubLibrary( const TQString& path, const TQString& name );
/**
* Deletes a sub library. Only removes the entry from the library
* doesn't delete the objects file
* @param subLibName The name of the sub library ( or sub libraries path ) to delete
* @return PMLibraryHandle::Ok if successul or the reason of failure
*/
PMLibraryHandle::PMResult deleteSubLibrary( const TQString& subLibName );
/**
* Returns true if the library is set read-only
*/
bool isReadOnly( ) const { return m_readOnly; }
/**
* Returns an object iterator. It has to be deleted afterwards.
*/
PMLibraryHandle::EntryIterator* createObjectIterator( );
/**
* Returns a sub-library iterator. It has to be deleted afterwards.
*/
PMLibraryHandle::EntryIterator* createSubLibraryIterator( );
/**
* Returns true if the library is a sub library.
*/
bool isSubLibrary( ) const { return m_subLibrary; }
/**
* Changes the parent library if this is a sub library
* @param parentPath The new parent path for this library
* @return PMLibraryHandle::Ok if successful or the reason for failure
*/
PMLibraryHandle::PMResult changeParentLibrary( const TQString& parentPath );
private:
/**
* Makes the library a sub library.
*/
void setSubLibrary( bool isSubLibrary );
void loadLibraryInfo( );
TQString m_name;
TQString m_path;
TQString m_author;
TQString m_description;
bool m_readOnly;
bool m_subLibrary;
TQDict<TQString> m_objects;
TQDict<TQString> m_libraries;
};
#endif
|
