ShiData.h

Go to the documentation of this file.

/*****************************************************************
|
|   Sushi - Data Objects
|
|   $Id: ShiData.h 7930 2014-06-25 11:05:10Z 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) 2005-2014 by Intertrust. All rights reserved. 
|
****************************************************************/
#ifndef _SHI_DATA_H_
#define _SHI_DATA_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "ShiResults.h"
#include "ShiTypes.h"
#include "ShiInterfaces.h"

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef enum {
    SHI_DATA_TYPE_UNKNOWN,    
    SHI_DATA_TYPE_INTEGER,    
    SHI_DATA_TYPE_STRING,     
    SHI_DATA_TYPE_BOOLEAN,    
    SHI_DATA_TYPE_BYTE_ARRAY, 
    SHI_DATA_TYPE_ARRAY,      
    SHI_DATA_TYPE_OBJECT,     
    SHI_DATA_TYPE_POINTER     
} SHI_DataType;

typedef union SHI_DataValue SHI_DataValue;

typedef struct {
    SHI_DataType         value_type;  
    SHI_Cardinal         value_count; 
    const SHI_DataValue* values;      
} SHI_ValueArray;

typedef struct {
    SHI_InterfaceId interface_id; 
    const void*     instance;     
} SHI_TypedObject;

typedef struct {
    SHI_UInt32  type_id; 
    const void* pointer; 
} SHI_TypedPointer;

typedef struct {
    const void* a0; 
    const void* a1; 
} SHI_DataAny;

union SHI_DataValue {
    SHI_DataAny      any;      
    SHI_Int32        integer;  
    const char*      string;   
    SHI_Boolean      boolean;  
    SHI_ByteArray    bytes;    
    SHI_ValueArray   array;    
    SHI_TypedObject  object;   
    SHI_TypedPointer pointer;  
};

/*----------------------------------------------------------------------
|   interfaces
+---------------------------------------------------------------------*/
#if defined(__cplusplus)
extern "C" {
#endif

typedef struct SHI_Data SHI_Data;

SHI_PUBLIC_API
SHI_Result
SHI_Data_Release(SHI_Data* self);

SHI_PUBLIC_API
SHI_DataType
SHI_Data_GetType(SHI_Data* self);

SHI_PUBLIC_API
const SHI_DataValue* 
SHI_Data_GetValue(SHI_Data* self);

#if defined(__cplusplus)
}
#endif

#endif /* _SHI_DATA_H_ */