oi.h

/* Copyright (c) 2011,2013 Øyvind Kolås
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 * Authors:  Øyvind Kolås    <pippin@gimp.org>
 */

#ifndef _OI_H
#define _OI_H
#include <string.h>

/* The variadic intance with trait's we use for all out oi-pointers */
typedef struct _Trait * var;


/* definition of a trait-type - to be associated with an instance */
typedef struct 
{
  const char     *name;  /* for debugging purposes */
  int             size;  /* size of a trait instance */

  /* function initializing a trait instance (or NULL) */
  void          (*init)    (var self, void *trait, var args);

  /* additional intialization used internally by oicc to make sure
   * dependent traits are satisfied.  */
  void          (*init_pre)(var self);

  /* additional intialization used by oicc to hook up message callbacks */
  void          (*init_int)(var self, void *trait);

  /* release resources held by trait instance */
  void          (*destroy) (var self, void *trait);

  /* duplicate this traits state in the clone (includes adding the trait) */
  void          (*dup)     (var self, var clone);
} Type;

/* this macro is used for creating the instance from the set of pointers,
 * as well as declaring a pointer to the instance.
 *
 */
#define OI(NAME, s, init, init_pre, init_int, destroy, dup) \
static Type NAME##_trait = {"" #NAME, sizeof (s), init, init_pre, init_int, destroy, dup};\
Type *NAME = &NAME##_trait;

#include "ref.h"

inline static void ref_clean (void *p)
{
  void **pp = p;
  ref_dec(*pp);
}
#define PACKED                __attribute__((packed))
//#define CLEANUP(cleanup_func) __attribute__((cleanup(cleanup_func)))
//#define avar var CLEANUP(ref_clean)


#include "oi-mem.h"

#include "own.h"
/* core capabilities */
#include "trait.h"

/* we define property type globally, since use of properties
 * is common; having a common integer type reference to them
 * is useful.
 */
typedef enum
{
  OI_PTYPE_FLOAT,
  OI_PTYPE_DOUBLE,
  OI_PTYPE_INT,
  OI_PTYPE_STRING,
  OI_PTYPE_POINTER,
  OI_PTYPE_OI
} PropertyType;

#include "value.h"
#include "property.h"
#include "message.h"
#include "mutex.h"
#include "list.h"
#include "oistring.h"
#include "program.h"

/* avar is an automatically dereffed version of var... */

#endif