src/corelib/plugin/qplugin.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtCore module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #ifndef QPLUGIN_H
       
    43 #define QPLUGIN_H
       
    44 
       
    45 #include <QtCore/qobject.h>
       
    46 #include <QtCore/qpointer.h>
       
    47 
       
    48 QT_BEGIN_HEADER
       
    49 
       
    50 QT_BEGIN_NAMESPACE
       
    51 
       
    52 QT_MODULE(Core)
       
    53 
       
    54 #ifndef Q_EXTERN_C
       
    55 #  ifdef __cplusplus
       
    56 #    define Q_EXTERN_C extern "C"
       
    57 #  else
       
    58 #    define Q_EXTERN_C extern
       
    59 #  endif
       
    60 #endif
       
    61 
       
    62 typedef QObject *(*QtPluginInstanceFunction)();
       
    63 
       
    64 void Q_CORE_EXPORT qRegisterStaticPluginInstanceFunction(QtPluginInstanceFunction function);
       
    65 
       
    66 #define Q_IMPORT_PLUGIN(PLUGIN) \
       
    67         extern QT_PREPEND_NAMESPACE(QObject) *qt_plugin_instance_##PLUGIN(); \
       
    68         class Static##PLUGIN##PluginInstance{ \
       
    69         public: \
       
    70                 Static##PLUGIN##PluginInstance() { \
       
    71                 qRegisterStaticPluginInstanceFunction(qt_plugin_instance_##PLUGIN); \
       
    72                 } \
       
    73         }; \
       
    74        static Static##PLUGIN##PluginInstance static##PLUGIN##Instance;
       
    75 
       
    76 #define Q_PLUGIN_INSTANCE(IMPLEMENTATION) \
       
    77         { \
       
    78             static QT_PREPEND_NAMESPACE(QPointer)<QT_PREPEND_NAMESPACE(QObject)> _instance; \
       
    79             if (!_instance)      \
       
    80                 _instance = new IMPLEMENTATION; \
       
    81             return _instance; \
       
    82         }
       
    83 
       
    84 #  define Q_EXPORT_PLUGIN(PLUGIN) \
       
    85             Q_EXPORT_PLUGIN2(PLUGIN, PLUGIN)
       
    86 
       
    87 #  define Q_EXPORT_STATIC_PLUGIN(PLUGIN) \
       
    88             Q_EXPORT_STATIC_PLUGIN2(PLUGIN, PLUGIN)
       
    89 
       
    90 #if defined(QT_STATICPLUGIN)
       
    91 
       
    92 #  define Q_EXPORT_PLUGIN2(PLUGIN, PLUGINCLASS) \
       
    93             QT_PREPEND_NAMESPACE(QObject) \
       
    94                 *qt_plugin_instance_##PLUGIN() \
       
    95             Q_PLUGIN_INSTANCE(PLUGINCLASS)
       
    96 
       
    97 #  define Q_EXPORT_STATIC_PLUGIN2(PLUGIN, PLUGINCLASS) \
       
    98             Q_EXPORT_PLUGIN2(PLUGIN, PLUGINCLASS)
       
    99 
       
   100 #else
       
   101 // NOTE: if you change pattern, you MUST change the pattern in
       
   102 // qlibrary.cpp as well.  changing the pattern will break all
       
   103 // backwards compatibility as well (no old plugins will be loaded).
       
   104 #  ifdef QPLUGIN_DEBUG_STR
       
   105 #    undef QPLUGIN_DEBUG_STR
       
   106 #  endif
       
   107 #  ifdef QT_NO_DEBUG
       
   108 #    define QPLUGIN_DEBUG_STR "false"
       
   109 #  else
       
   110 #    define QPLUGIN_DEBUG_STR "true"
       
   111 #  endif
       
   112 #  define Q_PLUGIN_VERIFICATION_DATA \
       
   113     static const char *qt_plugin_verification_data = \
       
   114       "pattern=""QT_PLUGIN_VERIFICATION_DATA""\n" \
       
   115       "version="QT_VERSION_STR"\n" \
       
   116       "debug="QPLUGIN_DEBUG_STR"\n" \
       
   117       "buildkey="QT_BUILD_KEY;
       
   118 
       
   119 #  if defined (Q_OS_WIN32) && defined(Q_CC_BOR)
       
   120 #     define Q_STANDARD_CALL __stdcall
       
   121 #  else
       
   122 #     define Q_STANDARD_CALL
       
   123 #  endif
       
   124 
       
   125 #  define Q_EXPORT_PLUGIN2(PLUGIN, PLUGINCLASS)      \
       
   126             Q_PLUGIN_VERIFICATION_DATA \
       
   127             Q_EXTERN_C Q_DECL_EXPORT \
       
   128             const char * Q_STANDARD_CALL qt_plugin_query_verification_data() \
       
   129             { return qt_plugin_verification_data; } \
       
   130             Q_EXTERN_C Q_DECL_EXPORT QT_PREPEND_NAMESPACE(QObject) * Q_STANDARD_CALL qt_plugin_instance() \
       
   131             Q_PLUGIN_INSTANCE(PLUGINCLASS)
       
   132 
       
   133 #  define Q_EXPORT_STATIC_PLUGIN2(PLUGIN, PLUGINCLASS)
       
   134 
       
   135 #endif
       
   136 
       
   137 QT_END_NAMESPACE
       
   138 
       
   139 QT_END_HEADER
       
   140 
       
   141 #endif // Q_PLUGIN_H