fba66b325c
Change-Id: I19d30a1ef4236dbe0a0053dad67a5ba7b1586fc8 Reviewed-on: https://gerrit.libreoffice.org/35054 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Johnny_M <klasse@partyheld.de> Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
176 lines
13 KiB
C++
176 lines
13 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 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_FRAMEWORK_INC_MACROS_XINTERFACE_HXX
|
|
#define INCLUDED_FRAMEWORK_INC_MACROS_XINTERFACE_HXX
|
|
|
|
#include <com/sun/star/uno/RuntimeException.hpp>
|
|
|
|
#include <com/sun/star/uno/Any.hxx>
|
|
#include <com/sun/star/uno/Type.hxx>
|
|
#include <cppuhelper/queryinterface.hxx>
|
|
#include <rtl/ustring.hxx>
|
|
|
|
namespace framework{
|
|
|
|
/*_________________________________________________________________________________________________________________
|
|
|
|
macros for declaration and definition of XInterface
|
|
Please use follow public macros only!
|
|
|
|
1) DEFINE_XINTERFACE => use it in header to declare XInterface and his methods
|
|
2) DIRECT_INTERFACE( INTERFACE ) => use it as parameter INTERFACEx at 4) if interface not ambiguous
|
|
3) DERIVED_INTERFACE( BASEINTERFACE, DERIVEDINTERFACE ) => use it as parameter INTERFACEx at 4) if interface can be ambiguous
|
|
4) DECLARE_XINTERFACE_0( CLASS, BASECLASS ) => use it to define implementation of XInterface for 0 additional interface to baseclass
|
|
DECLARE_XINTERFACE_1( CLASS, BASECLASS, INTERFACE1 ) => use it to define implementation of XInterface for 1 additional interface to baseclass
|
|
...
|
|
DECLARE_XINTERFACE_16( CLASS, BASECLASS, INTERFACE1, ... , INTERFACE16 )
|
|
|
|
_________________________________________________________________________________________________________________*/
|
|
|
|
// private
|
|
// implementation of XInterface::acquire()
|
|
// XInterface::release()
|
|
|
|
#define PRIVATE_DEFINE_XINTERFACE_ACQUIRE_RELEASE( CLASS, BASECLASS ) \
|
|
void SAL_CALL CLASS::acquire() throw() \
|
|
{ \
|
|
/* Don't use mutex in methods of XInterface! */ \
|
|
BASECLASS::acquire(); \
|
|
} \
|
|
\
|
|
void SAL_CALL CLASS::release() throw() \
|
|
{ \
|
|
/* Don't use mutex in methods of XInterface! */ \
|
|
BASECLASS::release(); \
|
|
}
|
|
|
|
// private
|
|
// complete implementation of XInterface with max. 12 other interfaces!
|
|
|
|
#define PRIVATE_DEFINE_XINTERFACE( CLASS, BASECLASS, INTERFACES ) \
|
|
PRIVATE_DEFINE_XINTERFACE_ACQUIRE_RELEASE( CLASS, BASECLASS ) \
|
|
css::uno::Any SAL_CALL CLASS::queryInterface( const css::uno::Type& aType ) \
|
|
{ \
|
|
/* Attention: Don't use mutex or guard in this method!!! Is a method of XInterface. */ \
|
|
/* Ask for my own supported interfaces ... */ \
|
|
css::uno::Any aReturn ( ::cppu::queryInterface INTERFACES \
|
|
); \
|
|
/* If searched interface not supported by this class ... */ \
|
|
if ( !aReturn.hasValue() ) \
|
|
{ \
|
|
/* ... ask baseclass for interfaces! */ \
|
|
aReturn = BASECLASS::queryInterface( aType ); \
|
|
} \
|
|
/* Return result of this search. */ \
|
|
return aReturn; \
|
|
}
|
|
|
|
// private
|
|
// help macros to replace INTERFACES in queryInterface() [see before]
|
|
|
|
/*
|
|
#ifdef ENABLE_SERVICEDEBUG
|
|
#define PRIVATE_DEFINE_INTERFACE_1( INTERFACE1 ) \
|
|
static_cast< XSPECIALDEBUGINTERFACE##* >( this ), \
|
|
INTERFACE1
|
|
#else
|
|
*/
|
|
#define PRIVATE_DEFINE_INTERFACE_1( INTERFACE1 ) \
|
|
INTERFACE1
|
|
//#endif // #ifdef ENABLE_SERVICEDEBUG
|
|
|
|
#define PRIVATE_DEFINE_INTERFACE_6( INTERFACE1, INTERFACE2, INTERFACE3, INTERFACE4, INTERFACE5, INTERFACE6 ) \
|
|
PRIVATE_DEFINE_INTERFACE_1( INTERFACE1 ), \
|
|
INTERFACE2, \
|
|
INTERFACE3, \
|
|
INTERFACE4, \
|
|
INTERFACE5, \
|
|
INTERFACE6
|
|
|
|
#define PRIVATE_DEFINE_INTERFACE_11( INTERFACE1, INTERFACE2, INTERFACE3, INTERFACE4, INTERFACE5, INTERFACE6, INTERFACE7, INTERFACE8, INTERFACE9, INTERFACE10, INTERFACE11 ) \
|
|
PRIVATE_DEFINE_INTERFACE_6( INTERFACE1, INTERFACE2, INTERFACE3, INTERFACE4, INTERFACE5, INTERFACE6 ), \
|
|
INTERFACE7, \
|
|
INTERFACE8, \
|
|
INTERFACE9, \
|
|
INTERFACE10, \
|
|
INTERFACE11
|
|
|
|
// public
|
|
// help macros for follow XInterface definitions
|
|
|
|
// Use it as parameter for DEFINE_XINTERFACE_X(), if you CAN use an interface directly in queryInterface()!
|
|
#define DIRECT_INTERFACE( INTERFACE ) \
|
|
static_cast< INTERFACE* >( this )
|
|
|
|
// Use it as parameter for DEFINE_XINTERFACE_X(), if you CAN'T use an interface directly in queryInterface()!
|
|
// (zB at ambiguous errors!)
|
|
#define DERIVED_INTERFACE( BASEINTERFACE, DERIVEDINTERFACE ) \
|
|
static_cast< BASEINTERFACE* >( static_cast< DERIVEDINTERFACE* >( this ) )
|
|
|
|
// public
|
|
// declaration of XInterface
|
|
|
|
#define FWK_DECLARE_XINTERFACE \
|
|
virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override; \
|
|
virtual void SAL_CALL acquire ( ) throw() override; \
|
|
virtual void SAL_CALL release ( ) throw() override;
|
|
|
|
// public
|
|
// implementation of XInterface
|
|
|
|
// implementation of XInterface with 6 additional interfaces for queryInterface()
|
|
#define DEFINE_XINTERFACE_6( CLASS, BASECLASS, INTERFACE1, INTERFACE2, INTERFACE3, INTERFACE4, INTERFACE5, INTERFACE6 ) \
|
|
PRIVATE_DEFINE_XINTERFACE ( CLASS, \
|
|
BASECLASS, \
|
|
( aType, PRIVATE_DEFINE_INTERFACE_6 ( INTERFACE1 , \
|
|
INTERFACE2 , \
|
|
INTERFACE3 , \
|
|
INTERFACE4 , \
|
|
INTERFACE5 , \
|
|
INTERFACE6 \
|
|
) \
|
|
) \
|
|
)
|
|
|
|
// implementation of XInterface with 11 additional interfaces for queryInterface()
|
|
#define DEFINE_XINTERFACE_11( CLASS, BASECLASS, INTERFACE1, INTERFACE2, INTERFACE3, INTERFACE4, INTERFACE5, INTERFACE6, INTERFACE7, INTERFACE8, INTERFACE9, INTERFACE10, INTERFACE11 ) \
|
|
PRIVATE_DEFINE_XINTERFACE ( CLASS, \
|
|
BASECLASS, \
|
|
( aType, PRIVATE_DEFINE_INTERFACE_11 ( INTERFACE1 , \
|
|
INTERFACE2 , \
|
|
INTERFACE3 , \
|
|
INTERFACE4 , \
|
|
INTERFACE5 , \
|
|
INTERFACE6 , \
|
|
INTERFACE7 , \
|
|
INTERFACE8 , \
|
|
INTERFACE9 , \
|
|
INTERFACE10 , \
|
|
INTERFACE11 \
|
|
) \
|
|
) \
|
|
)
|
|
|
|
} // namespace framework
|
|
|
|
#endif // INCLUDED_FRAMEWORK_INC_MACROS_XINTERFACE_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|