office-gobmx/include/uno/dispatcher.h
msrijita18 b1fb6338cf tdf#130978 Added comment to all published API
Change-Id: I744788bde9778f85ccd9d7667e19d16842900a29
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/110248
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2021-02-02 20:56:27 +01:00

92 lines
3 KiB
C

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
/*
* This file is part of LibreOffice published API.
*/
#ifndef INCLUDED_UNO_DISPATCHER_H
#define INCLUDED_UNO_DISPATCHER_H
#include "sal/types.h"
#include "uno/any2.h"
#ifdef __cplusplus
extern "C"
{
#endif
struct _typelib_TypeDescription;
struct _uno_Interface;
/** Function pointer declaration for the binary C uno dispatch function. Any pure out or return
value will be constructed by the callee, iff no exception is signalled.
If an exception is signalled, the any *ppException is properly constructed by the callee,
otherwise the pointer *ppException is set to 0.
An attribute get call is indicated by a non-null return pointer.
@param pUnoI uno interface the call is performed on
@param pMemberType member type description of a method or attribute
@param pReturn pointer to return value memory;
pointer may be undefined if void method, null if attribute set call.
@param pArgs an array of pointers to arguments values.
(remark: the value of an interface reference stores a
uno_interface *, so you get it by *(uno_Interface **)pArgs[n])
@param ppException pointer to pointer to unconstructed any to signal an exception.
*/
typedef void (SAL_CALL * uno_DispatchMethod)(
struct _uno_Interface * pUnoI,
const struct _typelib_TypeDescription * pMemberType,
void * pReturn,
void * pArgs[],
uno_Any ** ppException );
#if defined( _WIN32)
#pragma pack(push, 8)
#endif
/** The binary C uno interface description.
*/
typedef struct SAL_DLLPUBLIC_RTTI _uno_Interface
{
/** Acquires uno interface.
@param pInterface uno interface
*/
void (SAL_CALL * acquire)( struct _uno_Interface * pInterface );
/** Releases uno interface.
@param pInterface uno interface
*/
void (SAL_CALL * release)( struct _uno_Interface * pInterface );
/** dispatch function
*/
uno_DispatchMethod pDispatcher;
} uno_Interface;
#if defined( _WIN32)
#pragma pack(pop)
#endif
#ifdef __cplusplus
}
#endif
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */