ShiAttributes.h

Go to the documentation of this file.

/*****************************************************************
|
|   Sushi - Attributes
|
|   $Id: ShiAttributes.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_ATTRIBUTES_H_
#define _SHI_ATTRIBUTES_H_

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

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define SHI_ATTRIBUTE_FLAG_VALUE_IS_CRITICAL 1

#define SHI_ATTRIBUTE_FLAG_VALUE_IS_HUMAN_READABLE 2

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef enum {
    SHI_ATTRIBUTE_TYPE_UNKNOWN,   
    SHI_ATTRIBUTE_TYPE_INTEGER,   
    SHI_ATTRIBUTE_TYPE_FLOAT,     
    SHI_ATTRIBUTE_TYPE_STRING,    
    SHI_ATTRIBUTE_TYPE_DATE,      
    SHI_ATTRIBUTE_TYPE_RESOURCE,  
    SHI_ATTRIBUTE_TYPE_LIST,      
    SHI_ATTRIBUTE_TYPE_BYTE_ARRAY 
} SHI_AttributeType;

typedef struct {
    const char*   mime_type; 
    const char*   language;  
    SHI_ByteArray payload;   
} SHI_Resource;

typedef union {
    const char*   string;     
    SHI_Int32     integer;    
    SHI_Float     floatv;     
    SHI_DateTime  date;       
    SHI_ByteArray byte_array; 
    SHI_Resource  resource;   
} SHI_AttributeValue;

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

typedef struct SHI_Attribute SHI_Attribute;

SHI_PUBLIC_API
SHI_Result
SHI_Attribute_Release(SHI_Attribute* self); 

SHI_PUBLIC_API
const char*
SHI_Attribute_GetName(SHI_Attribute* self);

SHI_PUBLIC_API
SHI_AttributeType
SHI_Attribute_GetType(SHI_Attribute* self);

SHI_PUBLIC_API
SHI_Flags
SHI_Attribute_GetFlags(SHI_Attribute* self);

SHI_PUBLIC_API
SHI_Result
SHI_Attribute_GetValue(SHI_Attribute* self, SHI_AttributeValue* value);

SHI_PUBLIC_API
SHI_Cardinal
SHI_Attribute_GetChildCount(SHI_Attribute* self);

SHI_PUBLIC_API
SHI_Result
SHI_Attribute_GetChildByName(SHI_Attribute*  self, 
                             const char*     name, 
                             SHI_Attribute** child);

SHI_PUBLIC_API
SHI_Result
SHI_Attribute_GetChildByIndex(SHI_Attribute*  self, 
                              SHI_Ordinal     indx,
                              SHI_Attribute** child);

#if defined(__cplusplus)
}
#endif

#endif /* _SHI_ATTRIBUTES_H_ */