include/uno/dispatcher.h

   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
  20 /*
  21  * This file is part of LibreOffice published API.
  22  */
  23 #ifndef INCLUDED_UNO_DISPATCHER_H
  24 #define INCLUDED_UNO_DISPATCHER_H
  25
  26 #include "sal/types.h"
  27 #include "uno/any2.h"
  28
  29 #ifdef __cplusplus
  30 extern "C"
  31 {
  32 #endif
  33
  34 struct _typelib_TypeDescription;
  35 struct _uno_Interface;
  36
  37 /** Function pointer declaration for the binary C uno dispatch function. Any pure out or return
  38     value will be constructed by the callee, iff no exception is signalled.
  39     If an exception is signalled, the any *ppException is properly constructed by the callee,
  40     otherwise the pointer *ppException is set to 0.
  41     An attribute get call is indicated by a non-null return pointer.
  42
  43     @param pUnoI        uno interface the call is performed on
  44     @param pMemberType  member type description of a method or attribute
  45     @param pReturn      pointer to return value memory;
  46                         pointer may be undefined if void method, null if attribute set call.
  47     @param pArgs        an array of pointers to arguments values.
  48                         (remark: the value of an interface reference stores a
  49                          uno_interface *, so you get it by *(uno_Interface **)pArgs[n])
  50     @param ppException  pointer to pointer to unconstructed any to signal an exception.
  51 */
  52 typedef void (SAL_CALL * uno_DispatchMethod)(
  53     struct _uno_Interface * pUnoI,
  54     const struct _typelib_TypeDescription * pMemberType,
  55     void * pReturn,
  56     void * pArgs[],
  57     uno_Any ** ppException );
  58
  59 #if defined( _WIN32)
  60 #pragma pack(push, 8)
  61 #endif
  62
  63 /** The binary C uno interface description.
  64 */
  65 typedef struct SAL_DLLPUBLIC_RTTI _uno_Interface
  66 {
  67     /** Acquires uno interface.
  68
  69         @param pInterface uno interface
  70     */
  71     void (SAL_CALL * acquire)( struct _uno_Interface * pInterface );
  72     /** Releases uno interface.
  73
  74         @param pInterface uno interface
  75     */
  76     void (SAL_CALL * release)( struct _uno_Interface * pInterface );
  77     /** dispatch function
  78     */
  79     uno_DispatchMethod pDispatcher;
  80 } uno_Interface;
  81
  82 #if defined( _WIN32)
  83 #pragma pack(pop)
  84 #endif
  85
  86 #ifdef __cplusplus
  87 }
  88 #endif
  89
  90 #endif
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */