/usr/include/licq/plugin/protocolbase.h is in licq-dev 1.6.0-2.
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 | /*
* This file is part of Licq, an instant messaging client for UNIX.
* Copyright (C) 2010-2011 Licq developers
*
* 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_PROTOCOLBASE_H
#define LICQ_PROTOCOLBASE_H
#include "protocolplugin.h"
namespace Licq
{
typedef ProtocolPlugin* (*ProtocolPluginFactoryPtr)(Licq::ProtocolPlugin::Params& p);
/**
* This struct contains the initial data and functions needed by Licq
* to load a protocol plugin.
*/
struct ProtocolPluginData
{
/**
* Magic value to identify an Licq protocol
* Must contain the characters 'L', 'i', 'c', 'q'
*/
char licqMagic[4];
/**
* Version of Licq this plugin is built for
* Example of format: 1023 for version 1.2.3
* This field can be set to LICQ_VERSION (from licq/version.h) at build time
* Plugin load will be aborted unless major and minor versions match
* e.g. Licq 1.5.3 will load a plugin for 1.5.1 but not 1.4.x or 1.6.x
*/
int licqVersion;
/**
* Pointer to a factory function that creates and returns a ProtocolPlugin object
* This function will be called once when the plugin library is loaded
* Note that the plugin should not be (fully) initialized by this.
* The init() and run() functions in Licq::Plugin will be called for this afterwards
*
* The factory function takes parameters that must be forwarded to the
* constructor of the ProtocolPlugin class.
*/
ProtocolPluginFactoryPtr pluginFactory;
};
} // namespace Licq
#ifdef __cplusplus
extern "C" {
#endif
/**
* Each protocol must contain the following symbol
*
* When a protocol is first loaded, this pointer is fetched and used to get
* the ProtocolData struct for the protocol.
*/
extern struct Licq::ProtocolPluginData LicqProtocolPluginData;
#ifdef __cplusplus
}
#endif
/*
* Convenience macro to define plugin data in a plugin
*
* Note: <licq/version.h> must be included
*
* @param factory Pointer to the plugin factory function
*/
#define LICQ_PROTOCOL_PLUGIN_DATA(factory) \
struct Licq::ProtocolPluginData LicqProtocolPluginData = { \
{'L', 'i', 'c', 'q' }, \
LICQ_VERSION, \
factory, \
}
#endif
|