/usr/include/licq/plugin/generalpluginfactory.h is in licq-dev 1.8.1-2build1.
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 | /*
* This file is part of Licq, an instant messaging client for UNIX.
* Copyright (C) 2013 Licq Developers <licq-dev@googlegroups.com>
*
* Please refer to the COPYRIGHT file distributed with this source
* distribution for the names of the individual contributors.
*
* Licq 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.
*
* Licq 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 Licq; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef LICQ_GENERALPLUGINFACTORY_H
#define LICQ_GENERALPLUGINFACTORY_H
#include "pluginfactory.h"
#include <boost/shared_ptr.hpp>
namespace Licq
{
class GeneralPluginInterface;
/**
* Factory for general plugins.
*
* All general plugins must implement this factory. See documentation for
* Licq::PluginFactory for additional information
*/
class GeneralPluginFactory : public PluginFactory
{
public:
/// Return the plugin's description
virtual std::string description() const = 0;
/// Return the plugin's usage instructions
virtual std::string usage() const = 0;
/// Return the path (relative to BASE_DIR) to the configuration file for the
/// plugin; or an empty string if none.
virtual std::string configFile() const = 0;
/// Create a new plugin instance
virtual GeneralPluginInterface* createPlugin() = 0;
protected:
virtual ~GeneralPluginFactory() { /* Empty */ }
};
/**
* This struct contains the initial data and functions needed by Licq to load a
* plugin. Use the LICQ_GENERAL_PLUGIN_DATA macro to create it.
*/
struct GeneralPluginData
{
/// Magic value to identify an Licq plugin
char magic[4];
/// Version of Licq this plugin is built for
int licqVersion;
/// Pointer to a function that creates and returns a factory object.
GeneralPluginFactory* (*createFactory)();
/// Called to destroy the factory when it is no longer needed
void (*destroyFactory)(GeneralPluginFactory* factory);
};
} // namespace Licq
#ifdef __cplusplus
extern "C" {
#endif
/**
* Each plugin must contain the following symbol
*
* When a plugin is first loaded, this pointer is fetched and used to get
* the GeneralPluginData struct for the plugin.
*/
extern Licq::GeneralPluginData LicqGeneralPluginData;
#ifdef __cplusplus
}
#endif
/*
* Convenience macro to define plugin data in a plugin
*
* Note: <licq/version.h> must be included
*
* @param create Pointer to the create factory function
* @param destroy Pointer to the destroy factory function
*/
#define LICQ_GENERAL_PLUGIN_DATA(create, destroy) \
Licq::GeneralPluginData LicqGeneralPluginData = \
{ {'L', 'i', 'c', 'q' }, LICQ_VERSION, create, destroy }
#endif
|