office-gobmx/cppuhelper/source/exc_thrower.cxx
Noel Grandin 60728712f0 loplugin:ostr in cppu,cppuhelper
Change-Id: I15c00d7a87396d07be2d10a0311f308a93e8eec3
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/166751
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Tested-by: Jenkins
2024-04-27 15:11:25 +02:00

313 lines
9.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 .
*/
#include <rtl/instance.hxx>
#include <osl/diagnose.h>
#include <sal/log.hxx>
#include <uno/dispatcher.hxx>
#include <uno/lbnames.h>
#include <uno/mapping.hxx>
#include <cppuhelper/detail/XExceptionThrower.hpp>
#include <com/sun/star/ucb/InteractiveAugmentedIOException.hpp>
#include <com/sun/star/ucb/NameClashException.hpp>
#include <com/sun/star/uno/RuntimeException.hpp>
#include <cppuhelper/exc_hlp.hxx>
using namespace ::cppu;
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
namespace
{
using cppuhelper::detail::XExceptionThrower;
struct ExceptionThrower : public uno_Interface, XExceptionThrower
{
ExceptionThrower();
virtual ~ExceptionThrower() {}
static Type const & getCppuType()
{
return cppu::UnoType<XExceptionThrower>::get();
}
// XInterface
virtual Any SAL_CALL queryInterface( Type const & type ) override;
virtual void SAL_CALL acquire() noexcept override;
virtual void SAL_CALL release() noexcept override;
// XExceptionThrower
virtual void SAL_CALL throwException( Any const & exc ) override;
virtual void SAL_CALL rethrowException() override;
};
extern "C"
{
void ExceptionThrower_acquire_release_nop(
SAL_UNUSED_PARAMETER uno_Interface * )
{}
void ExceptionThrower_dispatch(
uno_Interface * pUnoI, typelib_TypeDescription const * pMemberType,
void * pReturn, void * pArgs [], uno_Any ** ppException )
{
OSL_ASSERT( pMemberType->eTypeClass == typelib_TypeClass_INTERFACE_METHOD );
switch (reinterpret_cast< typelib_InterfaceMemberTypeDescription * >(
const_cast< typelib_TypeDescription * >( pMemberType ) )->
nPosition)
{
case 0: // queryInterface()
{
Type const & rType_demanded =
*static_cast< Type const * >( pArgs[ 0 ] );
if (rType_demanded.equals( cppu::UnoType<XInterface>::get() ) ||
rType_demanded.equals( ExceptionThrower::getCppuType() ))
{
typelib_TypeDescription * pTD = nullptr;
TYPELIB_DANGER_GET( &pTD, rType_demanded.getTypeLibType() );
uno_any_construct(
static_cast< uno_Any * >( pReturn ), &pUnoI, pTD, nullptr );
TYPELIB_DANGER_RELEASE( pTD );
}
else
{
uno_any_construct(
static_cast< uno_Any * >( pReturn ), nullptr, nullptr, nullptr );
}
*ppException = nullptr;
break;
}
case 1: // acquire()
case 2: // release()
*ppException = nullptr;
break;
case 3: // throwException()
{
uno_Any * pAny = static_cast< uno_Any * >( pArgs[ 0 ] );
OSL_ASSERT( pAny->pType->eTypeClass == typelib_TypeClass_EXCEPTION );
uno_type_any_construct( *ppException, pAny->pData, pAny->pType, nullptr );
break;
}
default:
{
OSL_ASSERT( false );
RuntimeException exc( u"not implemented!"_ustr );
uno_type_any_construct(
*ppException, &exc, cppu::UnoType<decltype(exc)>::get().getTypeLibType(), nullptr );
break;
}
}
}
} // extern "C"
Any ExceptionThrower::queryInterface( Type const & type )
{
if (type.equals( cppu::UnoType<XInterface>::get() ) ||
type.equals( ExceptionThrower::getCppuType() ))
{
XExceptionThrower * that = this;
return Any( &that, type );
}
return Any();
}
void ExceptionThrower::acquire() noexcept
{
}
void ExceptionThrower::release() noexcept
{
}
void ExceptionThrower::throwException( Any const & exc )
{
OSL_FAIL( "unexpected!" );
cppu::throwException( exc );
}
void ExceptionThrower::rethrowException()
{
throw;
}
ExceptionThrower::ExceptionThrower()
{
uno_Interface::acquire = ExceptionThrower_acquire_release_nop;
uno_Interface::release = ExceptionThrower_acquire_release_nop;
uno_Interface::pDispatcher = ExceptionThrower_dispatch;
}
#if defined(IOS) || defined(ANDROID) || defined(EMSCRIPTEN)
#define RETHROW_FAKE_EXCEPTIONS 1
#else
#define RETHROW_FAKE_EXCEPTIONS 0
#endif
class theExceptionThrower : public rtl::Static<ExceptionThrower, theExceptionThrower> {};
#if RETHROW_FAKE_EXCEPTIONS
// In the native iOS / Android app, where we don't have any Java, Python,
// BASIC, or other scripting, the only thing that would use the C++/UNO bridge
// functionality that invokes codeSnippet() was cppu::throwException().
//
// codeSnippet() is part of what corresponds to the code that uses
// run-time-generated machine code on other platforms. We can't generate code
// at run-time on iOS, that has been known forever.
//
// Instead of digging in and trying to understand what is wrong, another
// solution was chosen. It turns out that the number of types of exception
// objects thrown by cppu::throwException() is fairly small. During startup of
// the LibreOffice code, and loading of an .odt document, only one kind of
// exception is thrown this way... (The lovely
// css::ucb:InteractiveAugmentedIOException.)
//
// So we can simply have code that checks what the type of object being thrown
// is, and explicitly throws such an object then with a normal C++ throw
// statement. Seems to work.
template <class E> void tryThrow(css::uno::Any const& aException)
{
E aSpecificException;
if (aException >>= aSpecificException)
throw aSpecificException;
}
void lo_mobile_throwException(css::uno::Any const& aException)
{
assert(aException.getValueTypeClass() == css::uno::TypeClass_EXCEPTION);
tryThrow<css::ucb::InteractiveAugmentedIOException>(aException);
tryThrow<css::ucb::NameClashException>(aException);
tryThrow<css::uno::RuntimeException>(aException);
SAL_WARN("cppuhelper", "lo_mobile_throwException: Unhandled exception type: " << aException.getValueTypeName());
assert(false);
}
#endif // RETHROW_FAKE_EXCEPTIONS
} // anonymous namespace
namespace cppu
{
void SAL_CALL throwException( Any const & exc )
{
if (exc.getValueTypeClass() != TypeClass_EXCEPTION)
{
throw RuntimeException(
u"no UNO exception given "
"(must be derived from com::sun::star::uno::Exception)!"_ustr );
}
#if RETHROW_FAKE_EXCEPTIONS
lo_mobile_throwException(exc);
#else
Mapping uno2cpp(Environment(u"" UNO_LB_UNO ""_ustr), Environment::getCurrent());
if (! uno2cpp.is())
{
throw RuntimeException(
u"cannot get binary UNO to C++ mapping!"_ustr );
}
Reference< XExceptionThrower > xThrower;
uno2cpp.mapInterface(
reinterpret_cast< void ** >( &xThrower ),
static_cast< uno_Interface * >( &theExceptionThrower::get() ),
ExceptionThrower::getCppuType() );
OSL_ASSERT( xThrower.is() );
xThrower->throwException( exc );
#endif // !RETHROW_FAKE_EXCEPTIONS
}
Any SAL_CALL getCaughtException()
{
// why does this differ from RETHROW_FAKE_EXCEPTIONS?
#if defined(ANDROID) || defined(EMSCRIPTEN)
return Any();
#else
Mapping cpp2uno(Environment::getCurrent(), Environment(u"" UNO_LB_UNO ""_ustr));
if (! cpp2uno.is())
{
throw RuntimeException(
u"cannot get C++ to binary UNO mapping!"_ustr );
}
Mapping uno2cpp(Environment(u"" UNO_LB_UNO ""_ustr), Environment::getCurrent());
if (! uno2cpp.is())
{
throw RuntimeException(
u"cannot get binary UNO to C++ mapping!"_ustr );
}
typelib_TypeDescription * pTD = nullptr;
TYPELIB_DANGER_GET(
&pTD, ExceptionThrower::getCppuType().getTypeLibType() );
UnoInterfaceReference unoI;
cpp2uno.mapInterface(
reinterpret_cast< void ** >( &unoI.m_pUnoI ),
static_cast< XExceptionThrower * >( &theExceptionThrower::get() ), pTD );
OSL_ASSERT( unoI.is() );
typelib_TypeDescription * pMemberTD = nullptr;
TYPELIB_DANGER_GET(
&pMemberTD,
reinterpret_cast< typelib_InterfaceTypeDescription * >( pTD )->
ppMembers[ 1 ] /* rethrowException() */ );
uno_Any exc_mem;
uno_Any * exc = &exc_mem;
unoI.dispatch( pMemberTD, nullptr, nullptr, &exc );
TYPELIB_DANGER_RELEASE( pMemberTD );
TYPELIB_DANGER_RELEASE( pTD );
if (exc == nullptr)
{
throw RuntimeException( u"rethrowing C++ exception failed!"_ustr );
}
Any ret;
uno_any_destruct( &ret, reinterpret_cast< uno_ReleaseFunc >(cpp_release) );
uno_type_any_constructAndConvert(
&ret, exc->pData, exc->pType, uno2cpp.get() );
uno_any_destruct( exc, nullptr );
return ret;
#endif
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */