common/interface.h

Go to the documentation of this file.

/*
  interface.h  -  Lumiera interface macros and structures

  Copyright (C)         Lumiera.org
    2008,               Christian Thaeter <ct@pipapo.org>

  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., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef LUMIERA_INTERFACE_H
#define LUMIERA_INTERFACE_H

#include "lib/luid.h"
#include "lib/ppmpl.h"
#include "lib/psplay.h"

/* TODO better doxygen formating */

/*
  Interface declaration macros
 */

#define LUMIERA_INTERFACE_INAME(name, version) name##_##version

#define LUMIERA_INTERFACE_DNAME(iname, version, dname) PPMPL_CAT (LUMIERA_INTERFACE_INAME (iname, version), _##dname)

#define LUMIERA_INTERFACE_DSTRING(iname, version, dname) PPMPL_STRINGIFY (LUMIERA_INTERFACE_DNAME (iname, version, dname))

#define LUMIERA_INTERFACE_REF(iname, version, dname) \
  (LumieraInterface)&LUMIERA_INTERFACE_DNAME(iname, version, dname)


#define LUMIERA_INTERFACE_TYPE(name, version) struct LUMIERA_INTERFACE_INAME(name, version)


#define LUMIERA_INTERFACE_CAST(name, version) (LUMIERA_INTERFACE_TYPE(name, version)*)


#define LUMIERA_INTERFACE_DECLARE(name, version, ...)   \
LUMIERA_INTERFACE_TYPE(name, version)                   \
{                                                       \
  lumiera_interface interface_header_;                  \
  PPMPL_FOREACH(_, __VA_ARGS__)                         \
}

#define PPMPL_FOREACH_LUMIERA_INTERFACE_SLOT(ret, name, params)  \
        ret (*name) params; \
                             lumiera_uid name##_uid;


/*
  Interface definition macros
 */

#define LUMIERA_INTERFACE_INSTANCE(iname, version, name, descriptor, acquire, release, ...)     \
PPMPL_FOREACH(_P1_, __VA_ARGS__)                                                                \
LUMIERA_INTERFACE_TYPE(iname, version) LUMIERA_INTERFACE_DNAME(iname, version, name) =          \
{                                                                                               \
{                                                                                               \
  #iname,                                                                                       \
  version,                                                                                      \
  #name,                                                                                        \
  sizeof (LUMIERA_INTERFACE_TYPE(iname, version)),                                              \
  descriptor,                                                                                   \
  acquire,                                                                                      \
  release                                                                                       \
},                                                                                              \
PPMPL_FOREACH(_P2_, __VA_ARGS__)                                                                \
}


#define PPMPL_FOREACH_P1_LUMIERA_INTERFACE_MAP(slot, luid, function)
#ifdef __cplusplus
#define PPMPL_FOREACH_P2_LUMIERA_INTERFACE_MAP(slot, luid, function) \
  function, LUMIERA_UID_INITIALIZER (luid),
#else
#define PPMPL_FOREACH_P2_LUMIERA_INTERFACE_MAP(slot, luid, function) \
  .slot = function, .slot##_uid = LUMIERA_UID_INITIALIZER (luid),
#endif


#define PPMPL_FOREACH_P1_LUMIERA_INTERFACE_INLINE(slot, luid, ret, params, ...) \
  static ret                                                                    \
  LUMIERA_INTERFACE_INLINE_NAME(slot) params                                    \
  __VA_ARGS__

#ifdef __cplusplus
#define PPMPL_FOREACH_P2_LUMIERA_INTERFACE_INLINE(slot, luid, ret, params, ...) \
  LUMIERA_INTERFACE_INLINE_NAME(slot), LUMIERA_UID_INITIALIZER (luid),
#else
#define PPMPL_FOREACH_P2_LUMIERA_INTERFACE_INLINE(slot, luid, ret, params, ...) \
  .slot = LUMIERA_INTERFACE_INLINE_NAME(slot), .slot##_uid = LUMIERA_UID_INITIALIZER (luid),
#endif

#define LUMIERA_INTERFACE_INLINE_NAME(slot) PPMPL_CAT(lumiera_##slot##_l, __LINE__)


#define PPMPL_FOREACH_L1_P1_LUMIERA_INTERFACE_DEFINE(iname, version, name, descriptor, acquire, release, ...)   \
LUMIERA_INTERFACE_INSTANCE (iname, version,                                                                     \
                            name,                                                                               \
                            descriptor,                                                                         \
                            acquire,                                                                            \
                            release,                                                                            \
                            __VA_ARGS__                                                                         \
                            );


#define PPMPL_FOREACH_L1_P2_LUMIERA_INTERFACE_DEFINE(iname, version, name, descriptor, acquire, release, ...)     \
  &LUMIERA_INTERFACE_DNAME(iname, version, name).interface_header_,


#define LUMIERA_EXPORT(...)                     \
PPMPL_FOREACH_L1(_P1_, __VA_ARGS__)             \
static LumieraInterface*                        \
lumiera_plugin_interfaces (void)                \
{                                               \
 static LumieraInterface interfaces[] =         \
  {                                             \
    PPMPL_FOREACH_L1(_P2_, __VA_ARGS__)         \
    NULL                                        \
  };                                            \
  return interfaces;                            \
}                                               \
LUMIERA_PLUGININTERFACE


#ifdef LUMIERA_PLUGIN /* compile as plugin */
#define LUMIERA_PLUGIN_INTERFACEHANDLE static LUMIERA_INTERFACE_HANDLE(lumieraorg_interface, 0) lumiera_interface_handle
#define LUMIERA_PLUGIN_STORE_INTERFACEHANDLE(name)  lumiera_interface_handle = LUMIERA_INTERFACE_CAST (lumieraorg_interface, 0) name

#define LUMIERA_PLUGININTERFACE                                                         \
LUMIERA_INTERFACE_INSTANCE (lumieraorg__plugin, 0,                                      \
                            lumieraorg_plugin,                                          \
                            NULL,                                                       \
                            NULL,                                                       \
                            NULL,                                                       \
                            LUMIERA_INTERFACE_MAP (plugin_interfaces,                   \
                                                   "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0",  \
                                                   lumiera_plugin_interfaces)           \
                            );
#define LUMIERA_INTERFACE_REGISTEREXPORTED
#define LUMIERA_INTERFACE_UNREGISTEREXPORTED

#define  LUMIERA_INTERFACE_OPEN(interface, version, minminor, name) \
  LUMIERA_INTERFACE_CAST(interface, version) lumiera_interface_handle->open (#interface, version, minminor, #name)

#define  LUMIERA_INTERFACE_CLOSE(handle) \
  lumiera_interface_handle->close (&(handle)->interface_header_)


#else /* compile as builtin */

#define LUMIERA_PLUGIN_INTERFACEHANDLE static LUMIERA_INTERFACE_HANDLE(lumieraorg_interface, 0) lumiera_interface_handle
#define LUMIERA_PLUGIN_STORE_INTERFACEHANDLE(name)  lumiera_interface_handle = LUMIERA_INTERFACE_CAST (lumieraorg_interface, 0) name

#define LUMIERA_PLUGININTERFACE

#define LUMIERA_INTERFACE_REGISTEREXPORTED      \
  lumiera_interfaceregistry_bulkregister_interfaces (lumiera_plugin_interfaces(), NULL)

#define LUMIERA_INTERFACE_UNREGISTEREXPORTED    \
  lumiera_interfaceregistry_bulkremove_interfaces (lumiera_plugin_interfaces())

#define  LUMIERA_INTERFACE_OPEN(interface, version, minminor, name) \
  LUMIERA_INTERFACE_CAST(interface, version) lumiera_interface_open (#interface, version, minminor, #name)

#define  LUMIERA_INTERFACE_CLOSE(handle) \
  lumiera_interface_close (&(handle)->interface_header_)

#endif



#define  LUMIERA_INTERFACE_HANDLE(interface, version) \
  LUMIERA_INTERFACE_TYPE(interface, version)*


typedef struct lumiera_interfaceslot_struct lumiera_interfaceslot;
typedef lumiera_interfaceslot* LumieraInterfaceslot;

typedef struct lumiera_interface_struct lumiera_interface;
typedef lumiera_interface* LumieraInterface;

struct lumiera_interfaceslot_struct
{
  void (*func)(void);
  lumiera_uid uid;
};


struct lumiera_interface_struct
{
  const char* interface;

  unsigned version;

  const char* name;

  size_t size;

  LumieraInterface descriptor;

  LumieraInterface (*acquire)(LumieraInterface self, LumieraInterface interfaces);
  void (*release)(LumieraInterface self);

#ifndef __cplusplus

  lumiera_interfaceslot functions[];
#endif
};

/*
  API to handle interfaces
 */

LumieraInterface
lumiera_interface_open (const char* interface, unsigned version, size_t minminorversion, const char* name);

void
lumiera_interface_close (LumieraInterface self);

unsigned
lumiera_interface_version (LumieraInterface self, const char* iname);

LUMIERA_INTERFACE_DECLARE (lumieraorg_interface, 0,
                           LUMIERA_INTERFACE_SLOT (LumieraInterface,
                                                   open,
                                                   (const char* interface, unsigned version, size_t minminorversion, const char* name)),
                           LUMIERA_INTERFACE_SLOT (void, close, (LumieraInterface self)),
                           LUMIERA_INTERFACE_SLOT (unsigned, version, (LumieraInterface self, const char* iname)),
);

void
lumiera_interface_init (void);

void
lumiera_interface_destroy (void);





LUMIERA_INTERFACE_DECLARE (lumieraorg__plugin, 0,
                           LUMIERA_INTERFACE_SLOT (LumieraInterface*, plugin_interfaces, (void)),
);



#endif /* LUMIERA_INTERFACE_H */
/*
// Local Variables:
// mode: C
// c-file-style: "gnu"
// indent-tabs-mode: nil
// End:
*/

---