/usr/include/klftools/klffactory.h is in libklatexformula3-dev 3.2.8-0ubuntu1.
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 | /***************************************************************************
* file klffactory.h
* This file is part of the KLatexFormula Project.
* Copyright (C) 2011 by Philippe Faist
* philippe.faist at bluewin.ch
* *
* 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. *
* *
* This program 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 General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/
/* $Id: klffactory.h 603 2011-02-26 23:14:55Z phfaist $ */
#ifndef KLFFACTORY_H
#define KLFFACTORY_H
#include <QString>
#include <QList>
#include <klfdefs.h>
class KLFFactoryManager;
//! Base class for factories
/** See \ref KLFFactoryManager.
*
* This class automatically registers to the factory manager given to the constructor; it
* also automatically unregisters itself in the destructor. */
class KLF_EXPORT KLFFactoryBase
{
public:
KLFFactoryBase(KLFFactoryManager *factoryManager);
virtual ~KLFFactoryBase();
//! A list of object types that this factory supports instantiating
virtual QStringList supportedTypes() const = 0;
private:
KLFFactoryManager *pFactoryManager;
};
//! A base abstract factory manager class
/** An abstract class that provides base common functions for factories of different kinds.
*
* A Factory is a class that can instantiate another class of given types. For example, you may have
* a factory that can create objects of the correct sub-class of KLFLibResourceEngine depending
* on the URL to open. Multiple factories can be installed, each capable of opening one or more subtypes
* of the given object, a library resource in our example.
*
* Factories need to be explicitely registered and unregistered, they are done so in the
* KLFFactoryBase constructor and destructor.
*
* The usage of KLFFactoryManager and KLFFactoryBase is for example:
* \code
* // in .h:
* class MyFactory : public KLFFactoryBase {
* public:
* MyFactory() : KLFFactoryBase(&pFactoryManager) { }
*
* virtual QStringList supportedTypes() const { ..... }
*
* ... virtual MyObject * createMyObject(const QString& ofThisObjectType) = 0; ...
*
* ...
*
* MyFactory * findFactoryFor(...) {
* return dynamic_cast<MyFactory*>(pFactoryManager.findFactoryFor(...));
* }
*
* private:
* static KLFFactoryManager pFactoryManager;
* };
*
* // in .cpp:
* KLFFactoryManager MyFactory::pFactoryManager ;
* \endcode
*/
class KLF_EXPORT KLFFactoryManager
{
public:
/** Constructor. does nothing*/
KLFFactoryManager();
/** Destructor. This function unregisters the factory. */
virtual ~KLFFactoryManager();
/** Returns the first factory in registered factory list that is capable of creating
* an object of type objType. */
KLFFactoryBase * findFactoryFor(const QString& objType);
/** Returns a combined list of all object types all registered factories combined support.
* (ie. a list of all object types we're capable of instantiating) */
QStringList allSupportedTypes();
/** Returns a list of all registered factories. */
inline QList<KLFFactoryBase*> registeredFactories() { return pRegisteredFactories; }
private:
//! List of registered factories
QList<KLFFactoryBase*> pRegisteredFactories;
//! Registers a factory
void registerFactory(KLFFactoryBase *factory);
//! Unregisters a factory
void unRegisterFactory(KLFFactoryBase *factory);
friend class KLFFactoryBase;
};
#endif
|