/usr/include/kresources/manager.h is in kdepimlibs5-dev 4:4.8.5-0ubuntu0.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 | /*
This file is part of libkresources.
Copyright (c) 2002 Tobias Koenig <tokoe@kde.org>
Copyright (c) 2002 Jan-Pascal van Best <janpascal@vanbest.org>
Copyright (c) 2003 Cornelius Schumacher <schumacher@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 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 KRESOURCES_MANAGER_H
#define KRESOURCES_MANAGER_H
#include "managerimpl.h"
#include "factory.h"
#include <kdebug.h>
#include <QtCore/QList>
#include <QtCore/QStringList>
namespace KRES {
class Resource;
/**
Observer class for Manager class. For getting notified about changes of
Resources managed by a Manager object implement this Observer interface and
add an object of this implementation to the Manager using addObserver(). The
resourceAdded(), resourceModified() and resourceDeleted() functions of your
implementation will be called whenever resources managed by the Manager object
are added, modified or deleted.
*/
template<class T>
class ManagerObserver
{
public:
virtual ~ManagerObserver(){}
virtual void resourceAdded( T *resource ) = 0;
virtual void resourceModified( T *resource ) = 0;
virtual void resourceDeleted( T *resource ) = 0;
};
/**
@internal
*/
class ManagerNotifier
{
public:
virtual ~ManagerNotifier(){}
virtual void notifyResourceAdded( Resource *resource ) = 0;
virtual void notifyResourceModified( Resource *resource ) = 0;
virtual void notifyResourceDeleted( Resource *resource ) = 0;
};
/**
This class provides a manager for resources of a specified family. It takes
care of loading and saving resource configurations and provides access to the
resources and their attributes. External changes in the resource configuration
are notified by the ManagerObserver interface. If your application needs to be
notified about resource configuration changes, you have to subclass
ManagerObserver and add it to the Manager by addObserver().
Since KDE 3.4 it's required to supply your application with a *.desktop
file for each resource family you introduce. The ServiceType should be of
KResources/Manager.
*/
template<class T>
class Manager : private ManagerNotifier
{
public:
/**
Iterator for iterations over all resources managed by a manager.
*/
class Iterator
{
friend class Manager;
public:
Iterator() {}
Iterator( const Iterator &it ) { mIt = it.mIt; }
T *operator*() { return static_cast<T *>( *mIt ); }
Iterator &operator++()
{
mIt++;
return *this;
}
Iterator &operator++( int )
{
mIt++;
return *this;
}
Iterator &operator--()
{
mIt--;
return *this;
}
Iterator &operator--( int )
{
mIt--;
return *this;
}
bool operator==( const Iterator &it ) const
{
return mIt == it.mIt;
}
bool operator!=( const Iterator &it ) const
{
return mIt != it.mIt;
}
private:
Resource::List::Iterator mIt;
};
/**
Typedef for STL style iterator
*/
typedef Iterator iterator;
/**
Return Iterator on first resource. If there is no resource returns end().
*/
Iterator begin()
{
Iterator it;
it.mIt = mImpl->resourceList()->begin();
return it;
}
/**
Return Iterator indicating end of resource list.
*/
Iterator end()
{
Iterator it;
it.mIt = mImpl->resourceList()->end();
return it;
}
/**
Iterator for iterations over only active resources managed by a manager.
*/
class ActiveIterator
{
friend class Manager;
public:
ActiveIterator() : mList( 0 ) {}
ActiveIterator( const ActiveIterator &it )
{
mIt = it.mIt;
mList = it.mList;
}
T *operator*() { return static_cast<T *>( *mIt ); }
ActiveIterator &operator++()
{
do { mIt++; } while ( checkActive() );
return *this;
}
ActiveIterator &operator++( int )
{
do { mIt++; } while ( checkActive() );
return *this;
}
ActiveIterator &operator--()
{
do { mIt--; } while ( checkActive() );
return *this;
}
ActiveIterator &operator--( int )
{
do { mIt--; } while ( checkActive() );
return *this;
}
bool operator==( const ActiveIterator &it ) const { return mIt == it.mIt; }
bool operator!=( const ActiveIterator &it ) const { return mIt != it.mIt; }
private:
/**
Check if iterator needs to be advanced once more.
*/
bool checkActive()
{
if ( !mList || mIt == mList->end() ) {
return false;
}
return !(*mIt)->isActive();
}
Resource::List::Iterator mIt;
Resource::List *mList;
};
/**
Return Iterator on first active resource. If there is no active resource
returns end().
*/
ActiveIterator activeBegin()
{
ActiveIterator it;
it.mIt = mImpl->resourceList()->begin();
it.mList = mImpl->resourceList();
if ( it.mIt != mImpl->resourceList()->end() ) {
if ( !(*it)->isActive() ) {
it++;
}
}
return it;
}
/**
Return Iterator indicating end of active resource list.
*/
ActiveIterator activeEnd()
{
ActiveIterator it;
it.mIt = mImpl->resourceList()->end();
it.mList = mImpl->resourceList();
return it;
}
/**
Return true, if manager doesn't hold any resources. If there are resources
return false.
*/
bool isEmpty() const { return mImpl->resourceList()->isEmpty(); }
/**
Create manager for given resource family. The family argument is used as
identifier for loading and saving resource configurations.
*/
Manager( const QString &family )
{
mFactory = Factory::self( family );
// The managerimpl will use the same Factory object as the manager
// because of the Factory::self() pattern
mImpl = new ManagerImpl( this, family );
}
virtual ~Manager()
{
delete mImpl;
}
/**
Recreate Resource objects from configuration file. If cfg is 0, read
standard configuration file determined by family name.
*/
void readConfig( KConfig *cfg = 0 )
{
mImpl->readConfig( cfg );
}
/**
Write configuration of Resource objects to configuration file. If cfg is
0, write to standard configuration file determined by family name.
*/
void writeConfig( KConfig *cfg = 0 )
{
mImpl->writeConfig( cfg );
}
/**
Add resource to manager. This passes ownership of the Resource object
to the manager.
*/
void add( Resource *resource )
{
if ( resource ) {
mImpl->add( resource );
}
}
/**
Remove resource from manager. This deletes the Resource object.
*/
void remove( Resource *resource )
{
if ( resource ) {
mImpl->remove( resource );
}
}
/**
Call this to notify manager about changes of the configuration of the
given resource.
*/
void change( T *resource )
{
mImpl->change( resource );
}
/**
Return standard resource.
*/
T *standardResource()
{
return static_cast<T *>( mImpl->standardResource() );
}
/**
Set standard resource.
*/
void setStandardResource( T *resource )
{
if ( resource ) {
mImpl->setStandardResource( resource );
}
}
/**
Set active state of resource.
*/
void setActive( Resource *resource, bool active )
{
if ( resource ) {
mImpl->setActive( resource, active );
}
}
/**
Returns a list of the names of the resources managed by the
Manager for this family.
*/
QStringList resourceNames() const
{
return mImpl->resourceNames();
}
/**
Creates a new resource of type @p type with default
settings. The resource is
not added to the manager, the application has to do that.
Returns a pointer to a resource object or a null pointer
if resource type doesn't exist.
@param type The type of the resource, one of those returned
by resourceTypeNames()
*/
T *createResource( const QString &type )
{
return dynamic_cast<T *>( mFactory->resource( type ) );
}
/**
Returns a list of the names of all available resource types.
*/
QStringList resourceTypeNames() const
{
return mFactory->typeNames();
}
/**
Return list of descriptions of all available resource types.
*/
QStringList resourceTypeDescriptions() const
{
QStringList typeDescs;
const QStringList types = mFactory->typeNames();
for ( QStringList::ConstIterator it = types.constBegin(); it != types.constEnd(); ++it ) {
QString desc = mFactory->typeName( *it );
if ( !mFactory->typeDescription( *it ).isEmpty() ) {
desc += QLatin1String( " (" ) + mFactory->typeDescription( *it ) + QLatin1Char( ')' );
}
typeDescs.append( desc );
}
return typeDescs;
}
/**
Add observer for resource changes to manager. See ManagerObserver. The
Manager does not take ownership of the Observer object.
*/
void addObserver( ManagerObserver<T> *observer )
{
mObservers.append( observer );
}
/**
Remove Observer for resource changes from manager. See ManagerObserver.
The Observer is not deleted by the Manager after being removed.
*/
void removeObserver( ManagerObserver<T> *observer )
{
mObservers.removeAll( observer );
}
private:
/**
Implementation of the ManagerNotifier interface.
*/
void notifyResourceAdded( Resource *res )
{
kDebug() << res->resourceName();
T *resource = dynamic_cast<T *>( res );
if ( resource ) {
for ( int i = 0; i < mObservers.size(); ++i ) {
mObservers.at(i)->resourceAdded( resource );
}
}
}
/**
Implementation of the ManagerNotifier interface.
*/
void notifyResourceModified( Resource *res )
{
kDebug() << res->resourceName();
T *resource = dynamic_cast<T *>( res );
if ( resource ) {
for ( int i = 0; i < mObservers.size(); ++i ) {
mObservers.at(i)->resourceAdded( resource );
}
}
}
/**
Implementation of the ManagerNotifier interface.
*/
void notifyResourceDeleted( Resource *res )
{
kDebug() << res->resourceName();
T *resource = dynamic_cast<T *>( res );
if ( resource ) {
for ( int i = 0; i < mObservers.size(); ++i ) {
mObservers.at(i)->resourceDeleted( resource );
}
}
}
private:
ManagerImpl *mImpl;
Factory *mFactory;
QList<ManagerObserver<T> *> mObservers;
};
}
#endif
|