WsbElements.h

Go to the documentation of this file.

/*****************************************************************
|
|   Wasabi - Elements
|
|   $Id: WsbElements.h 10793 2014-06-25 12:46:08Z jebaseelir $
|   Original author:  Gilles Boccon-Gibod
|
|   This software is provided to you pursuant to your agreement
|   with Intertrust Technologies Corporation ("Intertrust").
|   This software may be used only in accordance with the terms
|   of the agreement.
|
|   Copyright (c) 2003-2014 by Intertrust. All rights reserved.
|
****************************************************************/
 
#ifndef _WSB_ELEMENTS_H_
#define _WSB_ELEMENTS_H_
 
/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "WsbConfig.h"
#include "WsbTypes.h"

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef struct WSB_Element WSB_Element;

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
typedef enum {
    WSB_ELEMENT_TYPE_OBJECT = 0,
    WSB_ELEMENT_TYPE_STRING,
    WSB_ELEMENT_TYPE_INTEGER,
    WSB_ELEMENT_TYPE_FLOAT,
    WSB_ELEMENT_TYPE_ARRAY,
    WSB_ELEMENT_TYPE_BOOLEAN,
    WSB_ELEMENT_TYPE_NULL
} WSB_ElementType;

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

WSB_EXPORT void
WSB_Element_Release(WSB_Element* self);

WSB_EXPORT WSB_Element*
WSB_Element_GetChild(WSB_Element* self, const char* name);

WSB_EXPORT WSB_Element*
WSB_Element_GetChildAt(WSB_Element* self, WSB_Ordinal indx);

WSB_EXPORT WSB_Cardinal
WSB_Element_GetChildCount(WSB_Element* self);

WSB_EXPORT WSB_Element*
WSB_Element_GetParent(WSB_Element* self);

WSB_EXPORT const char*
WSB_Element_GetName(WSB_Element* self);

WSB_EXPORT WSB_ElementType
WSB_Element_GetType(WSB_Element* self);

WSB_EXPORT WSB_Int64
WSB_Element_AsInteger(WSB_Element* self);

WSB_EXPORT double
WSB_Element_AsFloat(WSB_Element* self);

WSB_EXPORT WSB_Boolean
WSB_Element_AsBoolean(WSB_Element* self);

WSB_EXPORT const char*
WSB_Element_AsString(WSB_Element* self);

WSB_EXPORT WSB_Result
WSB_Element_Serialize(WSB_Element* self, char* buffer, unsigned int* buffer_size);

WSB_EXPORT WSB_Result
WSB_Element_Clone(WSB_Element* self, WSB_Element** clone);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _WSB_ELEMENTS_H_ */