From 267c6f2ac71f92999e969232431ba04678e7437e Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 15 Apr 2024 07:54:39 +0200 Subject: Adding upstream version 4:24.2.0. Signed-off-by: Daniel Baumann --- include/systools/win32/comtools.hxx | 267 +++++++++++++++++++++++++++++ include/systools/win32/odbccp32.hxx | 54 ++++++ include/systools/win32/oleauto.hxx | 84 +++++++++ include/systools/win32/qswin32.h | 29 ++++ include/systools/win32/retry_if_failed.hxx | 38 ++++ include/systools/win32/uwinapi.h | 41 +++++ include/systools/win32/winstoreutil.hxx | 32 ++++ 7 files changed, 545 insertions(+) create mode 100644 include/systools/win32/comtools.hxx create mode 100644 include/systools/win32/odbccp32.hxx create mode 100644 include/systools/win32/oleauto.hxx create mode 100644 include/systools/win32/qswin32.h create mode 100644 include/systools/win32/retry_if_failed.hxx create mode 100644 include/systools/win32/uwinapi.h create mode 100644 include/systools/win32/winstoreutil.hxx (limited to 'include/systools/win32') diff --git a/include/systools/win32/comtools.hxx b/include/systools/win32/comtools.hxx new file mode 100644 index 0000000000..1d618051d2 --- /dev/null +++ b/include/systools/win32/comtools.hxx @@ -0,0 +1,267 @@ +/* -*- 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 . + */ + +#pragma once + +#include +#include +#include +#include +#include + +#include +#include +#include + +namespace sal::systools +{ + /* Simple exception class for propagating COM errors */ + class ComError : public std::runtime_error + { + public: + ComError(const std::string& message, HRESULT hr) : + std::runtime_error(message), + hr_(hr) + {} + + HRESULT GetHresult() const { return hr_; } + + private: + HRESULT hr_; + }; + + /* Convert failed HRESULT to thrown ComError */ + inline void ThrowIfFailed(HRESULT hr, std::string_view msg) + { + if (FAILED(hr)) + throw ComError(std::string(msg), hr); + } + + /* A guard class to call CoInitializeEx/CoUninitialize in proper pairs + * See also: o3tl::safeCoInitializeEx doing dangerous re-initialization + */ + class CoInitializeGuard + { + public: + enum class WhenFailed + { + NoThrow, // do not throw + Throw, // throw on failure + Abort, // std::abort on failure + }; + explicit CoInitializeGuard(DWORD dwCoInit, bool failChangeMode = false, + WhenFailed whenFailed = WhenFailed::Throw) + { + HRESULT hr = ::CoInitializeEx(nullptr, dwCoInit); + if (whenFailed != WhenFailed::NoThrow && FAILED(hr) + && (failChangeMode || hr != RPC_E_CHANGED_MODE)) + { + if (whenFailed == WhenFailed::Throw) + throw ComError("CoInitializeEx failed", hr); + else // if (whenFailed == Abort) + std::abort(); + } + mbUninit = SUCCEEDED(hr); + } + CoInitializeGuard(const CoInitializeGuard&) = delete; // non-construction-copyable + void operator=(const CoInitializeGuard&) = delete; // non-copyable + ~CoInitializeGuard() + { + if (mbUninit) + ::CoUninitialize(); + } + + private: + bool mbUninit; + }; + + struct COM_QUERY_TAG {} constexpr COM_QUERY; + struct COM_QUERY_THROW_TAG {} constexpr COM_QUERY_THROW; + template + constexpr bool is_COM_query_tag + = std::is_same_v || std::is_same_v; + + /* A simple COM smart pointer template */ + template + class COMReference + { + public: + /* Explicitly controllable whether AddRef will be called or not */ + COMReference(T* comptr = nullptr, bool bAddRef = true) : + com_ptr_(comptr) + { + if (bAddRef) + addRef(com_ptr_); + } + + COMReference(const COMReference& other) : + COMReference(other.com_ptr_) + { + } + + COMReference(COMReference&& other) : + COMReference(std::exchange(other.com_ptr_, nullptr), false) + { + } + + // Query from IUnknown*, using COM_QUERY or COM_QUERY_THROW tags + template + COMReference(const COMReference& p, TAG t) + : COMReference(p.template QueryInterface(t)) + { + } + + // Using CoCreateInstance + COMReference(REFCLSID clsid, IUnknown* pOuter = nullptr, DWORD nCtx = CLSCTX_ALL) + : com_ptr_(nullptr) + { + ThrowIfFailed(CoCreateInstance(clsid, pOuter, nCtx), "CoCreateInstance failed"); + } + + COMReference& operator=(const COMReference& other) + { + return operator=(other.com_ptr_); + } + + COMReference& operator=(COMReference&& other) + { + if (com_ptr_ != other.com_ptr_) + { + clear(); + std::swap(com_ptr_, other.com_ptr_); + } + return *this; + } + + COMReference& operator=(T* comptr) + { + assign(comptr); + return *this; + } + + ~COMReference() { release(com_ptr_); } + + template , int> = 0> + COMReference QueryInterface(TAG) const + { + T2* ip = nullptr; + HRESULT hr = E_POINTER; + if (com_ptr_) + hr = com_ptr_->QueryInterface(&ip); + + if constexpr (std::is_same_v) + ThrowIfFailed(hr, "QueryInterface failed"); + + return { ip, false }; + } + + template + COMReference& set(const COMReference& p, TAG t) + { + return operator=(p.template QueryInterface(t)); + } + + HRESULT CoCreateInstance(REFCLSID clsid, IUnknown* pOuter = nullptr, + DWORD nCtx = CLSCTX_ALL) + { + T* ip; + HRESULT hr = ::CoCreateInstance(clsid, pOuter, nCtx, IID_PPV_ARGS(&ip)); + if (SUCCEEDED(hr)) + release(std::exchange(com_ptr_, ip)); + return hr; + } + + HRESULT CoGetClassObject(REFCLSID clsid, DWORD nCtx = CLSCTX_ALL) + { + T* ip; + HRESULT hr = ::CoGetClassObject(clsid, nCtx, nullptr, IID_PPV_ARGS(&ip)); + if (SUCCEEDED(hr)) + release(std::exchange(com_ptr_, ip)); + return hr; + } + + T* operator->() const { return com_ptr_; } + + T& operator*() const { return *com_ptr_; } + + /* Necessary for assigning com_ptr_ from functions like + CoCreateInstance which require a 'void**' */ + T** operator&() + { + clear(); + return &com_ptr_; + } + + T* get() const { return com_ptr_; } + operator T* () const { return get(); } + + void clear() { assign(nullptr); } + + bool is() const { return (com_ptr_ != nullptr); } + operator bool() const { return is(); } + + private: + static void addRef(T* ptr) + { + if (ptr) + ptr->AddRef(); + } + + static void release(T* ptr) + { + if (ptr) + ptr->Release(); + } + + void assign(T* ptr) + { + if (com_ptr_ == ptr) + return; + addRef(ptr); + release(std::exchange(com_ptr_, ptr)); + } + + T* com_ptr_; + }; + + // A class to use with functions taking an out pointer argument, + // that needs to be freed with CoTaskMemFree - like SHGetKnownFolderPath + template class CoTaskMemAllocated + { + public: + ~CoTaskMemAllocated() { CoTaskMemFree(m_pv); } + + T** operator&() + { + CoTaskMemFree(std::exchange(m_pv, nullptr)); + return &m_pv; + }; + + operator T*() { return m_pv; } + + private: + T* m_pv = nullptr; + }; + +} // sal::systools + +/* Typedefs for some popular COM interfaces */ +typedef sal::systools::COMReference IDataObjectPtr; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/include/systools/win32/odbccp32.hxx b/include/systools/win32/odbccp32.hxx new file mode 100644 index 0000000000..bbfaf9eecb --- /dev/null +++ b/include/systools/win32/odbccp32.hxx @@ -0,0 +1,54 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */ +/* + * 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/. + */ + +#pragma once + +#include + +#include +#include + +namespace sal::systools +{ +// Linking to odbccp32 requires also legacy_stdio_definitions; and that breaks +// in some configurations, with make error 139. Load it dynamically instead. +class odbccp32 +{ +public: + odbccp32() + : m_hDLL(LoadLibraryW(L"odbccp32.dll")) + { + } + ~odbccp32() { FreeLibrary(m_hDLL); } + + bool SQLGetInstalledDrivers(LPWSTR sBuf, WORD nBufSize) const + { + using proc_t = BOOL __stdcall(LPWSTR, WORD, WORD*); + return Invoke("SQLGetInstalledDriversW", sBuf, nBufSize, nullptr); + } + + bool SQLManageDataSources(HWND hwndParent) + { + using proc_t = BOOL __stdcall(HWND); + return Invoke("SQLManageDataSources", hwndParent); + } + +private: + template bool Invoke(const char* func, Args... args) const + { + if (auto pFunc = reinterpret_cast(GetProcAddress(m_hDLL, func))) + return pFunc(args...); + return false; + } + + HMODULE m_hDLL; +}; +} // sal::systools + +/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */ diff --git a/include/systools/win32/oleauto.hxx b/include/systools/win32/oleauto.hxx new file mode 100644 index 0000000000..c01ac1225f --- /dev/null +++ b/include/systools/win32/oleauto.hxx @@ -0,0 +1,84 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */ +/* + * 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 . + */ + +#pragma once + +#include +#include +#include + +#include +#include +#include + +#include + +namespace sal::systools +{ +// BSTR safe wrapper +class BStr +{ +public: + BStr() = default; + BStr(std::u16string_view sv) + : m_Str(::SysAllocStringLen(o3tl::toW(sv.data()), sv.length())) + { + } + BStr(const BStr& src) + : BStr(std::u16string_view(src)) + { + } + BStr(BStr&& src) + : m_Str(std::exchange(src.m_Str, nullptr)) + { + } + ~BStr() { ::SysFreeString(m_Str); } + BStr& operator=(std::u16string_view sv) + { + ::SysFreeString( + std::exchange(m_Str, ::SysAllocStringLen(o3tl::toW(sv.data()), sv.length()))); + return *this; + } + BStr& operator=(const BStr& src) + { + if (&src != this) + operator=(std::u16string_view(src)); + return *this; + } + BStr& operator=(BStr&& src) + { + ::SysFreeString(std::exchange(m_Str, std::exchange(src.m_Str, nullptr))); + return *this; + } + operator std::u16string_view() const { return { o3tl::toU(m_Str), length() }; } + operator BSTR() const { return m_Str; } + BSTR* operator&() + { + assert(!m_Str); + return &m_Str; + } + UINT length() const { return ::SysStringLen(m_Str); } + +private: + BSTR m_Str = nullptr; +}; + +} // sal::systools + +/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */ diff --git a/include/systools/win32/qswin32.h b/include/systools/win32/qswin32.h new file mode 100644 index 0000000000..8bc7cac5e8 --- /dev/null +++ b/include/systools/win32/qswin32.h @@ -0,0 +1,29 @@ +/* -*- 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_SYSTOOLS_WIN32_QSWIN32_H +#define INCLUDED_SYSTOOLS_WIN32_QSWIN32_H + +#define QUICKSTART_CLASSNAME L"LO Listener Class" +#define QUICKSTART_WINDOWNAME L"LO Listener Window" +#define SHUTDOWN_QUICKSTART_MESSAGE L"LO KillTray" + +#endif // INCLUDED_SYSTOOLS_WIN32_QSWIN32_H + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/include/systools/win32/retry_if_failed.hxx b/include/systools/win32/retry_if_failed.hxx new file mode 100644 index 0000000000..1372843ab8 --- /dev/null +++ b/include/systools/win32/retry_if_failed.hxx @@ -0,0 +1,38 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */ +/* + * 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/. + */ + +#pragma once + +#include +#include + +#pragma comment(lib, "Kernel32.lib") // for Sleep + +namespace sal::systools +{ +// Some system calls (e.g., clipboard access functions) may fail first time, because the resource +// may only be accessed by one process at a time. This function allows to retry failed call up to +// specified number of times with a specified timeout (in ms), until the call succeeds or the limit +// of attempts is exceeded. +// Usage: +// HRESULT hr = sal::systools::RetryIfFailed(10, 100, []{ return OleFlushClipboard(); }); +template +std::enable_if_t, HRESULT>, HRESULT> +RetryIfFailed(unsigned times, unsigned msTimeout, Func func) +{ + for (unsigned i = 0;; ++i) + { + if (HRESULT hr = func(); SUCCEEDED(hr) || i >= times) + return hr; + Sleep(msTimeout); + } +} +} + +/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */ diff --git a/include/systools/win32/uwinapi.h b/include/systools/win32/uwinapi.h new file mode 100644 index 0000000000..501c9aa38e --- /dev/null +++ b/include/systools/win32/uwinapi.h @@ -0,0 +1,41 @@ +/* -*- 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_SYSTOOLS_WIN32_UWINAPI_H +#define INCLUDED_SYSTOOLS_WIN32_UWINAPI_H + +#include +#include + +#ifdef __cplusplus + +inline bool IsValidHandle(HANDLE handle) +{ + return handle != INVALID_HANDLE_VALUE && handle != nullptr; +} + +#else /* __cplusplus */ + +#define IsValidHandle(Handle) ((DWORD_PTR)(Handle) + 1 > 1) + +#endif /* __cplusplus */ + +#endif // INCLUDED_SYSTOOLS_WIN32_UWINAPI_H + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/include/systools/win32/winstoreutil.hxx b/include/systools/win32/winstoreutil.hxx new file mode 100644 index 0000000000..aa0a70e644 --- /dev/null +++ b/include/systools/win32/winstoreutil.hxx @@ -0,0 +1,32 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */ +/* + * 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/. + */ + +#pragma once + +#include + +#include +#include + +namespace sal::systools +{ +// Returns true if the current process is run as a Windows store app, which has some specifics +inline bool IsStorePackagedApp() +{ + // GetCurrentPackageFullName is only available since Windows 8 + HMODULE hDll = GetModuleHandleW(L"kernel32.dll"); + using Func_t = LONG WINAPI(UINT32*, PWSTR); + if (auto pFunc = reinterpret_cast(GetProcAddress(hDll, "GetCurrentPackageFullName"))) + if (UINT32 size = 0; pFunc(&size, nullptr) == ERROR_INSUFFICIENT_BUFFER) + return true; + return false; +} +} // sal::systools + +/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */ -- cgit v1.2.3