AtxProperties.h

Go to the documentation of this file.

/*****************************************************************
|
|   Atomix - Properties Interface
|
|   (c) 2002-2006 Gilles Boccon-Gibod
|   Author: Gilles Boccon-Gibod (bok@bok.net)
|
 ****************************************************************/
#ifndef _ATX_PROPERTIES_H_
#define _ATX_PROPERTIES_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "AtxInterfaces.h"
#include "AtxTypes.h"
#include "AtxIterator.h"

/*----------------------------------------------------------------------
|   error codes
+---------------------------------------------------------------------*/
#define ATX_ERROR_NO_SUCH_PROPERTY       (ATX_ERROR_BASE_PROPERTIES - 0)
#define ATX_ERROR_NO_SUCH_LISTENER       (ATX_ERROR_BASE_PROPERTIES - 1)
#define ATX_ERROR_PROPERTY_TYPE_MISMATCH (ATX_ERROR_BASE_PROPERTIES - 2)

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef enum {
    ATX_PROPERTY_TYPE_NONE,     
    ATX_PROPERTY_TYPE_INTEGER,  
    ATX_PROPERTY_TYPE_FLOAT,    
    ATX_PROPERTY_TYPE_STRING,   
    ATX_PROPERTY_TYPE_BOOLEAN,  
    ATX_PROPERTY_TYPE_RAW_DATA  
} ATX_PropertyType;

typedef struct {
    ATX_Size size;
    ATX_Any  data;
} ATX_PropertyRawData;

typedef union {
    void*               any;      
    ATX_CString         string;   
    ATX_Int32           integer;  
    ATX_Float           fp;       
    ATX_Boolean         boolean;  
    ATX_PropertyRawData raw_data; 
} ATX_PropertyValue;

typedef const void* ATX_PropertyListenerHandle;

typedef struct {
    ATX_CString       name;  
    ATX_PropertyType  type;  
    ATX_PropertyValue value; 
} ATX_Property;

/*----------------------------------------------------------------------
|   ATX_PropertyListener interface
+---------------------------------------------------------------------*/
ATX_DECLARE_INTERFACE(ATX_PropertyListener)
ATX_BEGIN_INTERFACE_DEFINITION(ATX_PropertyListener)
    void (*OnPropertyChanged)(ATX_PropertyListener*    self,
                              ATX_CString              name,
                              ATX_PropertyType         type,
                              const ATX_PropertyValue* value);
ATX_END_INTERFACE_DEFINITION

/*----------------------------------------------------------------------
|   ATX_Properties interface
+---------------------------------------------------------------------*/
ATX_DECLARE_INTERFACE(ATX_Properties)
ATX_BEGIN_INTERFACE_DEFINITION(ATX_Properties)
    ATX_Result (*GetProperty)(ATX_Properties* self,
                              ATX_CString     name,
                              ATX_Property*   property);

    ATX_Result (*SetProperty)(ATX_Properties*          self,
                              ATX_CString              name,
                              ATX_PropertyType         type,
                              const ATX_PropertyValue* value);

    ATX_Result (*UnsetProperty)(ATX_Properties* self,
                                ATX_CString     name);

    ATX_Result (*Clear)(ATX_Properties* self);

    ATX_Result (*GetIterator)(ATX_Properties* self,
                              ATX_Iterator**  iterator);
#if 0
    ATX_Result (*AddAlias)(ATX_PropertiesInstance* instance,
                           ATX_CString             alias,
                           ATX_CString             name);

    ATX_Result (*RemoveAlias)(ATX_PropertiesInstance* instance,
                              ATX_CString             alias);

    ATX_Result (*GetAliases)(ATX_PropertiesInstance* instance,
                             ATX_CString             name,
                             ATX_Iterator*           iterator);
#endif

    ATX_Result (*AddListener)(ATX_Properties*             self,
                              ATX_CString                 name,
                              ATX_PropertyListener*       listener, 
                              ATX_PropertyListenerHandle* handle);

    ATX_Result (*RemoveListener)(ATX_Properties*            self,
                                 ATX_PropertyListenerHandle handle);

ATX_END_INTERFACE_DEFINITION

/*----------------------------------------------------------------------
|   convenience macros
+---------------------------------------------------------------------*/
#define ATX_Properties_GetProperty(object, name, property)  \
ATX_INTERFACE(object)->GetProperty(object,                  \
                                   name,                    \
                                   property)

#define ATX_Properties_SetProperty(object, name, type, value)    \
ATX_INTERFACE(object)->SetProperty(object,                       \
                                   name,                         \
                                   type,                         \
                                   value)

#define ATX_Properties_UnsetProperty(object, name)               \
ATX_INTERFACE(object)->UnsetProperty(object, name)

#define ATX_Properties_Clear(object)                            \
ATX_INTERFACE(object)->Clear(object)

#define ATX_Properties_GetIterator(object, iterator)               \
ATX_INTERFACE(object)->GetIterator(object, iterator)

#define ATX_Properties_AddListener(object, name, listener, handle) \
ATX_INTERFACE(object)->AddListener(object,                         \
                                   name,                           \
                                   listener,                       \
                                   handle)

#define ATX_Properties_RemoveListener(object, handle)    \
ATX_INTERFACE(object)->RemoveListener(object, handle)

#define ATX_PropertyListener_OnPropertyChanged(object, name, type, value) \
ATX_INTERFACE(object)->OnPropertyChanged(object,                          \
                                         name,                            \
                                         type,                            \
                                         value)

/*----------------------------------------------------------------------
|   functions
+---------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

ATX_Result ATX_Properties_Create(ATX_Properties** properties);

#ifdef __cplusplus
}
#endif

#endif /* _ATX_PROPERTIES_H_ */