LCOV - code coverage report
Current view: top level - include/uno - any2.h (source / functions) Hit Total Coverage
Test: commit 10e77ab3ff6f4314137acd6e2702a6e5c1ce1fae Lines: 1 1 100.0 %
Date: 2014-11-03 Functions: 1 1 100.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : #ifndef INCLUDED_UNO_ANY2_H
      20             : #define INCLUDED_UNO_ANY2_H
      21             : 
      22             : #include <cppu/cppudllapi.h>
      23             : #include <uno/data.h>
      24             : 
      25             : #ifdef __cplusplus
      26             : extern "C"
      27             : {
      28             : #endif
      29             : 
      30             : #if defined( SAL_W32)
      31             : #pragma pack(push, 8)
      32             : #endif
      33             : 
      34             : struct _typelib_TypeDescriptionReference;
      35             : struct _typelib_TypeDescription;
      36             : struct _uno_Mapping;
      37             : 
      38             : /** This is the binary specification of an UNO any.
      39             : */
      40   321173897 : typedef struct _uno_Any
      41             : {
      42             :     /** type of value
      43             :     */
      44             :     struct _typelib_TypeDescriptionReference * pType;
      45             :     /** pointer to value; this may point to pReserved and thus the uno_Any is not anytime
      46             :         mem-copyable! You may have to correct the pData pointer to pReserved. Otherwise you need
      47             :         not, because the data is stored in heap space.
      48             :     */
      49             :     void * pData;
      50             :     /** reserved space for storing value
      51             :     */
      52             :     void * pReserved;
      53             : } uno_Any;
      54             : 
      55             : #if defined( SAL_W32)
      56             : #pragma pack(pop)
      57             : #endif
      58             : 
      59             : /** Assign an any with a given value. Interfaces are acquired or released by the given callback
      60             :     functions.
      61             : 
      62             :     @param pDest            pointer memory of destination any
      63             :     @param pSource          pointer to source value; defaults (0) to default constructed value
      64             :     @param pTypeDescr       type description of value; defaults (0) to void
      65             :     @param acquire          function called each time an interface needs to be acquired;
      66             :                             defaults (0) to uno
      67             :     @param release          function called each time an interface needs to be released;
      68             :                             defaults (0) to uno
      69             : */
      70             : CPPU_DLLPUBLIC void SAL_CALL uno_any_assign(
      71             :     uno_Any * pDest, void * pSource,
      72             :     struct _typelib_TypeDescription * pTypeDescr,
      73             :     uno_AcquireFunc acquire, uno_ReleaseFunc release )
      74             :     SAL_THROW_EXTERN_C();
      75             : /** Assign an any with a given value. Interfaces are acquired or released by the given callback
      76             :     functions.
      77             : 
      78             :     @param pDest            pointer memory of destination any
      79             :     @param pSource          pointer to source value; defaults (0) to default constructed value
      80             :     @param pType            type description of value; defaults (0) to void
      81             :     @param acquire          function called each time an interface needs to be acquired;
      82             :                             defaults (0) to uno
      83             :     @param release          function called each time an interface needs to be released;
      84             :                             defaults (0) to uno
      85             : */
      86             : CPPU_DLLPUBLIC void SAL_CALL uno_type_any_assign(
      87             :     uno_Any * pDest, void * pSource,
      88             :     struct _typelib_TypeDescriptionReference * pType,
      89             :     uno_AcquireFunc acquire, uno_ReleaseFunc release )
      90             :     SAL_THROW_EXTERN_C();
      91             : 
      92             : /** Constructs an any with a given value. Interfaces are acquired by the given callback function.
      93             : 
      94             :     @param pDest            pointer memory of destination any
      95             :     @param pSource          pointer to source value; defaults (0) to default constructed value
      96             :     @param pTypeDescr       type description of value; defaults (0) to void
      97             :     @param acquire          function called each time an interface needs to be acquired;
      98             :                             defaults (0) to uno
      99             : */
     100             : CPPU_DLLPUBLIC void SAL_CALL uno_any_construct(
     101             :     uno_Any * pDest, void * pSource,
     102             :     struct _typelib_TypeDescription * pTypeDescr,
     103             :     uno_AcquireFunc acquire )
     104             :     SAL_THROW_EXTERN_C();
     105             : /** Constructs an any with a given value. Interfaces are acquired by the given callback function.
     106             : 
     107             :     @param pDest            pointer memory of destination any
     108             :     @param pSource          pointer to source value; defaults (0) to default constructed value
     109             :     @param pType            type of value; defaults (0) to void
     110             :     @param acquire          function called each time an interface needs to be acquired;
     111             :                             defaults (0) to uno
     112             : */
     113             : CPPU_DLLPUBLIC void SAL_CALL uno_type_any_construct(
     114             :     uno_Any * pDest, void * pSource,
     115             :     struct _typelib_TypeDescriptionReference * pType,
     116             :     uno_AcquireFunc acquire )
     117             :     SAL_THROW_EXTERN_C();
     118             : 
     119             : /** Constructs an any with a given value and converts/ maps interfaces.
     120             : 
     121             :     @param pDest            pointer memory of destination any
     122             :     @param pSource          pointer to source value; defaults (0) to default constructed value
     123             :     @param pTypeDescr       type description of value; defaults (0) to void
     124             :     @param mapping          mapping to convert/ map interfaces
     125             : */
     126             : CPPU_DLLPUBLIC void SAL_CALL uno_any_constructAndConvert(
     127             :     uno_Any * pDest, void * pSource,
     128             :     struct _typelib_TypeDescription * pTypeDescr,
     129             :     struct _uno_Mapping * mapping )
     130             :     SAL_THROW_EXTERN_C();
     131             : /** Constructs an any with a given value and converts/ maps interfaces.
     132             : 
     133             :     @param pDest            pointer memory of destination any
     134             :     @param pSource          pointer to source value; defaults (0) to default constructed value
     135             :     @param pType            type of value; defaults (0) to void
     136             :     @param mapping          mapping to convert/ map interfaces
     137             : */
     138             : CPPU_DLLPUBLIC void SAL_CALL uno_type_any_constructAndConvert(
     139             :     uno_Any * pDest, void * pSource,
     140             :     struct _typelib_TypeDescriptionReference * pType,
     141             :     struct _uno_Mapping * mapping )
     142             :     SAL_THROW_EXTERN_C();
     143             : 
     144             : /** Destructs an any.
     145             : 
     146             :     @param pValue           pointer to any
     147             :     @param release          function called each time an interface needs to be released;
     148             :                             defaults (0) to uno
     149             : */
     150             : CPPU_DLLPUBLIC void SAL_CALL uno_any_destruct(
     151             :     uno_Any * pValue, uno_ReleaseFunc release )
     152             :     SAL_THROW_EXTERN_C();
     153             : 
     154             : /** Sets value to void.
     155             : 
     156             :     @param pValue           pointer to any
     157             :     @param release          function called each time an interface needs to be released;
     158             :                             defaults (0) to uno
     159             : */
     160             : CPPU_DLLPUBLIC void SAL_CALL uno_any_clear(
     161             :     uno_Any * pValue, uno_ReleaseFunc release )
     162             :     SAL_THROW_EXTERN_C();
     163             : 
     164             : #ifdef __cplusplus
     165             : }
     166             : #endif
     167             : 
     168             : #endif
     169             : 
     170             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

Generated by: LCOV version 1.10