ODFstudio/odfstudio
2
0
Fork 0
Code Issues Packages Activity
Files
f6b0e1736e7f16ca49e7995f1ea0e1e3f98277b2
odfstudio/vcl/source/app/salplug.cxx
T
Andrea Gelmini f6b0e1736e Fix typos 
Change-Id: I57ddd4f37138287fce235b10469257c1bcb1efe7
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/211772
Tested-by: Jenkins
Reviewed-by: Julien Nabet <serval2412@yahoo.fr>
2026-10-03 10:12:19 +02:00

386 lines
10 KiB
C++
Raw Blame History

/* -*- 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 .
*/
// The current high-level preprocessor structure is:
//
// if !HAVE_FEATURE_UI
// => STATIC_SAL_INSTANCE
// else
// ? !STATIC_SAL_INSTANCE
// ? UNIX_DESKTOP_DETECT
// endif
//
// ENABLE_HEADLESS just signifies the use of the SVP plugin!
#include <config_features.h>
#include <config_vclplug.h>
#include <cstdio>
#include <desktop/crashreport.hxx>
#include <rtl/bootstrap.hxx>
#include <rtl/process.h>
#include <salinst.hxx>
#include <sal/log.hxx>
#include <svdata.hxx>
#include <vcl/DesktopType.hxx>
#include <vcl/svapp.hxx>
#if HAVE_FEATURE_UI
#if USING_X11
#define UNIX_DESKTOP_DETECT 1
#else
#define UNIX_DESKTOP_DETECT 0
#endif
#endif
#if defined(DISABLE_DYNLOADING) || !HAVE_FEATURE_UI
#define STATIC_SAL_INSTANCE 1
#include <staticsalinstance.hxx>
#else
#define STATIC_SAL_INSTANCE 0
#include <osl/module.hxx>
#endif
#if defined(iOS)
#include <premac.h>
#include <UIKit/UIKit.h>
#include <postmac.h>
#elif defined(ANDROID)
#include <android/androidinst.hxx>
#endif
#if defined(_WIN32)
#include <o3tl/char16_t2wchar_t.hxx>
#include <salframe.hxx>
#include <Windows.h>
#else
#include <unistd.h>
#endif
#if ENABLE_HEADLESS
#include <headless/svpinst.hxx>
#include <unx/gendata.hxx>
#endif
namespace {
#if ENABLE_HEADLESS
SalInstance* svp_create_SalInstance()
{
return new SvpSalInstance(std::make_unique<SvpSalYieldMutex>(), new GenericUnixSalData);
}
#endif
#if HAVE_FEATURE_UI
#if !STATIC_SAL_INSTANCE
oslModule pCloseModule = nullptr;
extern "C" typedef SalInstance* (*salFactoryProc)();
SalInstance* tryInstance( const OUString& rModuleBase, bool bForce = false )
{
#if ENABLE_HEADLESS
if (rModuleBase == "svp")
return svp_create_SalInstance();
#endif
SalInstance* pInst = nullptr;
OUString aUsedModuleBase(rModuleBase);
if (aUsedModuleBase == "kde5")
aUsedModuleBase = "kf5";
OUString aModule(
#ifdef SAL_DLLPREFIX
SAL_DLLPREFIX
#endif
"vclplug_" + aUsedModuleBase + "lo" SAL_DLLEXTENSION );
osl::Module aMod;
if (aMod.loadRelative(reinterpret_cast<oslGenericFunction>(&tryInstance), aModule, SAL_LOADMODULE_GLOBAL))
{
salFactoryProc aProc = reinterpret_cast<salFactoryProc>(aMod.getFunctionSymbol("create_SalInstance"));
if (aProc)
{
pInst = aProc();
SAL_INFO(
"vcl.plugadapt",
"sal plugin " << aModule << " produced instance " << pInst);
if (pInst)
{
pCloseModule = static_cast<oslModule>(aMod);
aMod.release();
/*
* Recent GTK+ versions load their modules with RTLD_LOCAL, so we can
* not access the 'gnome_accessibility_module_shutdown' anymore.
* So make sure libgtk+ & co are still mapped into memory when
* atk-bridge's atexit handler gets called.
*/
if (aUsedModuleBase == "gtk4" || aUsedModuleBase == "gtk3" ||
aUsedModuleBase == "gtk3_kde5" || aUsedModuleBase == "kf5" ||
aUsedModuleBase == "kf6" ||
aUsedModuleBase == "qt5" || aUsedModuleBase == "qt6" ||
aUsedModuleBase == "win")
{
pCloseModule = nullptr;
}
}
}
else
{
SAL_WARN(
"vcl.plugadapt",
"could not load symbol create_SalInstance from shared object "
<< aModule);
}
}
else if (bForce)
{
SAL_WARN("vcl.plugadapt", "could not load shared object " << aModule);
}
else
{
SAL_INFO("vcl.plugadapt", "could not load shared object " << aModule);
}
// coverity[leaked_storage] - this is on purpose
return pInst;
}
#endif // !STATIC_SAL_INSTANCE
#if UNIX_DESKTOP_DETECT
#if !STATIC_SAL_INSTANCE
std::vector<OUString> autodetect_plugin_list()
{
const DesktopType eDesktop = get_desktop_environment();
#if ENABLE_HEADLESS
// no server at all: dummy plugin
if (eDesktop == DesktopType::Headless)
return { u"svp"_ustr };
#endif
std::vector<OUString> aPlugins;
if (eDesktop == DesktopType::LXQt || eDesktop == DesktopType::Plasma5 || eDesktop == DesktopType::Plasma6)
{
#if ENABLE_KF6
if (eDesktop == DesktopType::Plasma6)
aPlugins.push_back(u"kf6"_ustr);
#endif
#if ENABLE_KF5
aPlugins.push_back(u"kf5"_ustr);
#endif
#if ENABLE_GTK3_KDE5
aPlugins.push_back(u"gtk3_kde5"_ustr);
#endif
}
#if ENABLE_GTK3
aPlugins.push_back(u"gtk3"_ustr);
#endif
#if ENABLE_GEN
aPlugins.push_back(u"gen"_ustr);
#endif
return aPlugins;
}
#endif // !STATIC_SAL_INSTANCE
#endif // UNIX_DESKTOP_DETECT
#endif // HAVE_FEATURE_UI
// HACK to obtain Application::IsHeadlessModeEnabled early on, before
// Application::EnableHeadlessMode has potentially been called:
bool IsHeadlessModeRequested()
{
if (Application::IsHeadlessModeEnabled()) {
return true;
}
sal_uInt32 n = rtl_getAppCommandArgCount();
for (sal_uInt32 i = 0; i < n; ++i) {
OUString arg;
rtl_getAppCommandArg(i, &arg.pData);
if ( arg == "--headless" || arg == "-headless" ) {
return true;
}
}
return false;
}
} // anonymous namespace
SalInstance *CreateSalInstance()
{
OUString aUsePlugin;
rtl::Bootstrap::get(u"SAL_USE_VCLPLUGIN"_ustr, aUsePlugin);
SAL_INFO_IF(!aUsePlugin.isEmpty(), "vcl.plugadapt", "Requested VCL plugin: " << aUsePlugin);
if (Application::IsBitmapRendering() || (aUsePlugin.isEmpty() && IsHeadlessModeRequested()))
aUsePlugin = "svp";
if (aUsePlugin == "svp")
{
Application::EnableBitmapRendering();
#if ENABLE_HEADLESS
return svp_create_SalInstance();
#else
aUsePlugin.clear();
#endif
}
#if STATIC_SAL_INSTANCE
return create_SalInstance();
#else // !STATIC_SAL_INSTANCE
if( !aUsePlugin.isEmpty() )
{
if (SalInstance* pInst = tryInstance(aUsePlugin, true))
return pInst;
}
#if UNIX_DESKTOP_DETECT
const std::vector<OUString> aPluginList = autodetect_plugin_list();
for (const OUString& rPlugin : aPluginList)
{
SalInstance* pInst = tryInstance(rPlugin);
SAL_INFO_IF(pInst, "vcl.plugadapt", "plugin autodetection: " << rPlugin);
if (pInst)
return pInst;
}
#endif
// fallback, try everything
static constexpr OUString aPlugins[] = {
#if defined(MACOSX)
u"osx"_ustr,
#endif
#if ENABLE_WIN
u"win"_ustr,
#endif
#if ENABLE_GTK3
u"gtk3"_ustr,
#endif
#if ENABLE_KF5
u"kf5"_ustr,
#endif
#if ENABLE_GTK3_KDE5
u"gtk3_kde5"_ustr,
#endif
#if ENABLE_GEN
u"gen"_ustr,
#endif
#if ENABLE_QT5
u"qt5"_ustr,
#endif
#if ENABLE_KF6
u"kf6"_ustr,
#endif
#if ENABLE_QT6
u"qt6"_ustr,
#endif
};
for (const OUString& rPlugin : aPlugins)
{
if (SalInstance* pInst = tryInstance(rPlugin))
return pInst;
}
std::fprintf(stderr, "no suitable windowing system found, exiting.\n");
_exit(1);
#endif // !STATIC_SAL_INSTANCE
}
void DestroySalInstance( SalInstance *pInst )
{
delete pInst;
#if !STATIC_SAL_INSTANCE
if( pCloseModule )
osl_unloadModule( pCloseModule );
#endif
}
void SalAbort( const OUString& rErrorText, bool bDumpCore )
{
if (GetSalInstance())
GetSalInstance()->BeforeAbort();
#if defined _WIN32
(void)bDumpCore;
if( rErrorText.isEmpty() )
{
// make sure crash reporter is triggered
RaiseException( 0, EXCEPTION_NONCONTINUABLE, 0, nullptr );
FatalAppExitW( 0, L"Application Error" );
}
else
{
CrashReporter::addKeyValue("AbortMessage", rErrorText, CrashReporter::Write);
// make sure crash reporter is triggered
RaiseException( 0, EXCEPTION_NONCONTINUABLE, 0, nullptr );
FatalAppExitW( 0, o3tl::toW(rErrorText.getStr()) );
}
#else // !_WIN32
#if defined ANDROID
OUString aError(rErrorText.isEmpty() ? "Unspecified application error" : rErrorText);
LOGE("SalAbort: '%s'", OUStringToOString(aError, osl_getThreadTextEncoding()).getStr());
#elif defined(iOS)
NSLog(@"SalAbort: %s", OUStringToOString(rErrorText, osl_getThreadTextEncoding()).getStr());
#else
if( rErrorText.isEmpty() )
std::fprintf( stderr, "Unspecified Application Error\n" );
else
{
CrashReporter::addKeyValue(u"AbortMessage"_ustr, rErrorText, CrashReporter::Write);
std::fprintf( stderr, "%s\n", OUStringToOString(rErrorText, osl_getThreadTextEncoding()).getStr() );
}
#endif
if( bDumpCore )
abort();
else
_exit(1);
#endif // !_WIN32
}
DesktopType SalGetDesktopEnvironment()
{
#if !HAVE_FEATURE_UI
return DesktopType::Headless;
#elif defined(_WIN32)
return DesktopType::Windows;
#elif defined(MACOSX)
return DesktopType::macOS;
#elif defined(__EMSCRIPTEN__)
return DesktopType::WASM;
#elif defined(ANDROID)
return DesktopType::Android;
#elif defined(iOS)
return DesktopType::iOS;
#elif UNIX_DESKTOP_DETECT
static DesktopType eDesktop = get_desktop_environment();
return eDesktop;
#else
return DesktopType::Unknown;
#endif
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in New Issue View Git Blame Copy Permalink