Files
libreoffice/cppu/inc/uno/any2.h
Rüdiger Timm 77c65851b3 INTEGRATION: CWS ooo19126 (1.9.178); FILE MERGED
2005/09/05 13:54:15 rt 1.9.178.1: #i54170# Change license header: remove SISSL
2005-09-08 07:38:13 +00:00

193 lines
6.9 KiB
C

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: any2.h,v $
*
* $Revision: 1.10 $
*
* last change: $Author: rt $ $Date: 2005-09-08 08:38:13 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef _UNO_ANY2_H_
#define _UNO_ANY2_H_
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
#endif
#ifndef _UNO_DATA_H_
#include <uno/data.h>
#endif
#ifdef __cplusplus
extern "C"
{
#endif
#ifdef SAL_W32
#pragma pack(push, 8)
#elif defined(SAL_OS2)
#pragma pack(8)
#endif
struct _typelib_TypeDescriptionReference;
struct _typelib_TypeDescription;
struct _uno_Mapping;
/** This is the binary specification of an UNO any.
*/
typedef struct _uno_Any
{
/** type of value
*/
struct _typelib_TypeDescriptionReference * pType;
/** pointer to value; this may point to pReserved and thus the uno_Any is not anytime
mem-copyable! You may have to correct the pData pointer to pReserved. Otherwise you need
not, because the data is stored in heap space.
*/
void * pData;
/** reserved space for storing value
*/
void * pReserved;
} uno_Any;
#ifdef SAL_W32
#pragma pack(pop)
#elif defined(SAL_OS2)
#pragma pack()
#endif
/** Assign an any with a given value. Interfaces are acquired or released by the given callback
functions.
@param pDest pointer memory of destination any
@param pSource pointer to source value; defaults (0) to default constructed value
@param pTypeDescr type description of value; defaults (0) to void
@param acquire function called each time an interface needs to be acquired;
defaults (0) to uno
@param release function called each time an interface needs to be released;
defaults (0) to uno
*/
void SAL_CALL uno_any_assign(
uno_Any * pDest, void * pSource,
struct _typelib_TypeDescription * pTypeDescr,
uno_AcquireFunc acquire, uno_ReleaseFunc release )
SAL_THROW_EXTERN_C();
/** Assign an any with a given value. Interfaces are acquired or released by the given callback
functions.
@param pDest pointer memory of destination any
@param pSource pointer to source value; defaults (0) to default constructed value
@param pTypeDescr type description of value; defaults (0) to void
@param acquire function called each time an interface needs to be acquired;
defaults (0) to uno
@param release function called each time an interface needs to be released;
defaults (0) to uno
*/
void SAL_CALL uno_type_any_assign(
uno_Any * pDest, void * pSource,
struct _typelib_TypeDescriptionReference * pType,
uno_AcquireFunc acquire, uno_ReleaseFunc release )
SAL_THROW_EXTERN_C();
/** Constructs an any with a given value. Interfaces are acquired by the given callback function.
@param pDest pointer memory of destination any
@param pSource pointer to source value; defaults (0) to default constructed value
@param pTypeDescr type description of value; defaults (0) to void
@param acquire function called each time an interface needs to be acquired;
defaults (0) to uno
*/
void SAL_CALL uno_any_construct(
uno_Any * pDest, void * pSource,
struct _typelib_TypeDescription * pTypeDescr,
uno_AcquireFunc acquire )
SAL_THROW_EXTERN_C();
/** Constructs an any with a given value. Interfaces are acquired by the given callback function.
@param pDest pointer memory of destination any
@param pSource pointer to source value; defaults (0) to default constructed value
@param pType type of value; defaults (0) to void
@param acquire function called each time an interface needs to be acquired;
defaults (0) to uno
*/
void SAL_CALL uno_type_any_construct(
uno_Any * pDest, void * pSource,
struct _typelib_TypeDescriptionReference * pType,
uno_AcquireFunc acquire )
SAL_THROW_EXTERN_C();
/** Constructs an any with a given value and converts/ maps interfaces.
@param pDest pointer memory of destination any
@param pSource pointer to source value; defaults (0) to default constructed value
@param pTypeDescr type description of value; defaults (0) to void
@param mapping mapping to convert/ map interfaces
*/
void SAL_CALL uno_any_constructAndConvert(
uno_Any * pDest, void * pSource,
struct _typelib_TypeDescription * pTypeDescr,
struct _uno_Mapping * mapping )
SAL_THROW_EXTERN_C();
/** Constructs an any with a given value and converts/ maps interfaces.
@param pDest pointer memory of destination any
@param pSource pointer to source value; defaults (0) to default constructed value
@param pType type of value; defaults (0) to void
@param mapping mapping to convert/ map interfaces
*/
void SAL_CALL uno_type_any_constructAndConvert(
uno_Any * pDest, void * pSource,
struct _typelib_TypeDescriptionReference * pType,
struct _uno_Mapping * mapping )
SAL_THROW_EXTERN_C();
/** Destructs an any.
@param pValue pointer to any
@param release function called each time an interface needs to be released;
defaults (0) to uno
*/
void SAL_CALL uno_any_destruct(
uno_Any * pValue, uno_ReleaseFunc release )
SAL_THROW_EXTERN_C();
/** Sets value to void.
@param pValue pointer to any
@param release function called each time an interface needs to be released;
defaults (0) to uno
*/
void SAL_CALL uno_any_clear(
uno_Any * pValue, uno_ReleaseFunc release )
SAL_THROW_EXTERN_C();
#ifdef __cplusplus
}
#endif
#endif