environment.h

Go to the documentation of this file.

/* -*- 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_ENVIRONMENT_H
#define INCLUDED_UNO_ENVIRONMENT_H
 
#include "cppu/cppudllapi.h"
#include "rtl/ustring.h"
 
#include <stdarg.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
struct _uno_ExtEnvironment;
struct _typelib_InterfaceTypeDescription;
 
#if defined( _WIN32)
#pragma pack(push, 8)
#endif
 
typedef struct SAL_DLLPUBLIC_RTTI _uno_Environment
{
    void *              pReserved;
 
    rtl_uString *       pTypeName;
 
    void *              pContext;
 
    struct _uno_ExtEnvironment * pExtEnv;
 
    void (SAL_CALL * acquire)( struct _uno_Environment * pEnv );
 
    void (SAL_CALL * release)( struct _uno_Environment * pEnv );
 
    void (SAL_CALL * acquireWeak)( struct _uno_Environment * pEnv );
 
    void (SAL_CALL * releaseWeak)( struct _uno_Environment * pEnv );
 
    void (SAL_CALL * harden)(
        struct _uno_Environment ** ppHardEnv,
        struct _uno_Environment * pEnv );
 
    void (SAL_CALL * dispose)( struct _uno_Environment * pEnv );
 
    /* ===== the following part will be late initialized by a matching bridge ===== *
     * ===== and is NOT for public use.                                       ===== */
 
    void (SAL_CALL * environmentDisposing)( struct _uno_Environment * pEnv );
} uno_Environment;
 
typedef void (SAL_CALL * uno_freeProxyFunc)( struct _uno_ExtEnvironment * pEnv, void * pProxy );
 
typedef void * (SAL_CALL * uno_memAlloc)( sal_Size nBytes );
 
typedef struct SAL_DLLPUBLIC_RTTI _uno_ExtEnvironment
{
    uno_Environment aBase;
 
    void (SAL_CALL * registerInterface)(
        struct _uno_ExtEnvironment * pEnv,
        void ** ppInterface,
        rtl_uString * pOId,
        struct _typelib_InterfaceTypeDescription * pTypeDescr );
 
    void (SAL_CALL * registerProxyInterface)(
        struct _uno_ExtEnvironment * pEnv,
        void ** ppProxy,
        uno_freeProxyFunc freeProxy,
        rtl_uString * pOId,
        struct _typelib_InterfaceTypeDescription * pTypeDescr );
 
    void (SAL_CALL * revokeInterface)(
        struct _uno_ExtEnvironment * pEnv,
        void * pInterface );
 
    void (SAL_CALL * getObjectIdentifier)(
        struct _uno_ExtEnvironment * pEnv,
        rtl_uString ** ppOId,
        void * pInterface );
 
    void (SAL_CALL * getRegisteredInterface)(
        struct _uno_ExtEnvironment * pEnv,
        void ** ppInterface,
        rtl_uString * pOId,
        struct _typelib_InterfaceTypeDescription * pTypeDescr );
 
    void (SAL_CALL * getRegisteredInterfaces)(
        struct _uno_ExtEnvironment * pEnv,
        void *** pppInterfaces,
        sal_Int32 * pnLen,
        uno_memAlloc memAlloc );
 
    /* ===== the following part will be late initialized by a matching bridge ===== */
 
    void (SAL_CALL * computeObjectIdentifier)(
        struct _uno_ExtEnvironment * pEnv,
        rtl_uString ** ppOId, void * pInterface );
 
    void (SAL_CALL * acquireInterface)(
        struct _uno_ExtEnvironment * pEnv,
        void * pInterface );
 
    void (SAL_CALL * releaseInterface)(
        struct _uno_ExtEnvironment * pEnv,
        void * pInterface );
 
} uno_ExtEnvironment;
 
#if defined( _WIN32)
#pragma pack(pop)
#endif
 
typedef void (SAL_CALL * uno_initEnvironmentFunc)( uno_Environment * pEnv );
#define UNO_INIT_ENVIRONMENT "uno_initEnvironment"
 
#ifdef DISABLE_DYNLOADING
/* We link statically and have just the C++ environment */
void SAL_CALL CPPU_ENV_uno_initEnvironment( uno_Environment * Env )
     SAL_THROW_EXTERN_C();
 
/* We might also have the Java environment */
void SAL_CALL java_uno_initEnvironment( uno_Environment * Env )
     SAL_THROW_EXTERN_C();
#endif
 
CPPU_DLLPUBLIC void SAL_CALL uno_getEnvironment(
    uno_Environment ** ppEnv, rtl_uString * pEnvDcp, void * pContext )
    SAL_THROW_EXTERN_C();
 
CPPU_DLLPUBLIC void SAL_CALL uno_getRegisteredEnvironments(
    uno_Environment *** pppEnvs, sal_Int32 * pnLen, uno_memAlloc memAlloc,
    rtl_uString * pEnvDcp )
    SAL_THROW_EXTERN_C();
 
CPPU_DLLPUBLIC void SAL_CALL uno_createEnvironment(
    uno_Environment ** ppEnv, rtl_uString * pEnvDcp, void * pContext )
    SAL_THROW_EXTERN_C();
 
CPPU_DLLPUBLIC void SAL_CALL uno_dumpEnvironment(
    void * stream, uno_Environment * pEnv, const char * pFilter )
    SAL_THROW_EXTERN_C();
CPPU_DLLPUBLIC void SAL_CALL uno_dumpEnvironmentByName(
    void * stream, rtl_uString * pEnvDcp, const char * pFilter )
    SAL_THROW_EXTERN_C();
 
 
 
CPPU_DLLPUBLIC void SAL_CALL uno_getCurrentEnvironment(uno_Environment ** ppEnv, rtl_uString * pTypeName)
    SAL_THROW_EXTERN_C();
 
typedef void SAL_CALL uno_EnvCallee(va_list * pParam);
 
CPPU_DLLPUBLIC void SAL_CALL uno_Environment_invoke_v(uno_Environment * pEnv, uno_EnvCallee * pCallee, va_list * pParam)
    SAL_THROW_EXTERN_C();
 
CPPU_DLLPUBLIC void SAL_CALL uno_Environment_invoke (uno_Environment * pEnv, uno_EnvCallee * pCallee, ...)
    SAL_THROW_EXTERN_C();
 
CPPU_DLLPUBLIC void SAL_CALL uno_Environment_enter(uno_Environment * pEnv)
    SAL_THROW_EXTERN_C();
 
CPPU_DLLPUBLIC int SAL_CALL uno_Environment_isValid(uno_Environment * pEnv, rtl_uString ** pReason)
    SAL_THROW_EXTERN_C();
 
#ifdef __cplusplus
}
#endif
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */