From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- include/comphelper/servicedecl.hxx | 155 +++++++++++++++++++++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 include/comphelper/servicedecl.hxx (limited to 'include/comphelper/servicedecl.hxx') diff --git a/include/comphelper/servicedecl.hxx b/include/comphelper/servicedecl.hxx new file mode 100644 index 000000000..57da446e6 --- /dev/null +++ b/include/comphelper/servicedecl.hxx @@ -0,0 +1,155 @@ +/* -*- 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_COMPHELPER_SERVICEDECL_HXX +#define INCLUDED_COMPHELPER_SERVICEDECL_HXX + +#include +#include +#include + +#include +#include + +namespace comphelper::service_decl { + +class ServiceDecl; + +namespace detail { +typedef ::std::function< + css::uno::Reference /* return */ + (ServiceDecl const&, + css::uno::Sequence const&, + css::uno::Reference const&)> CreateFuncF; +} + +/** Class to declare a service implementation. There is no need to implement + lang::XServiceInfo nor lang::XInitialization anymore. + The declaration can be done in various ways, the (simplest) form is + +
+    class MyClass : public cppu::WeakImplHelper {
+    public:
+        MyClass( uno::Reference const& xContext )
+        [...]
+    };
+    [...]
+    namespace sdecl = comphelper::service_decl;
+    sdecl::ServiceDecl const myDecl(
+        sdecl::class_(),
+        "my.unique.implementation.name",
+        "MyServiceSpec1;MyServiceSpec2" );
+    
+ + If the service demands initialization by arguments, the implementation + class has to define a constructor taking both arguments and component + context: + +
+    class MyClass : public cppu::WeakImplHelper {
+    public:
+        MyClass( uno::Sequence const& args,
+                 uno::Reference const& xContext )
+        [...]
+    };
+    [...]
+    namespace sdecl = comphelper::service_decl;
+    sdecl::ServiceDecl const myDecl(
+        sdecl::class_ >(),
+        "my.unique.implementation.name",
+        "MyServiceSpec1;MyServiceSpec2" );
+    
+ + Additionally, there is the possibility to process some code after creation, + e.g. to add the newly created object as a listener or perform aggregation + (C++-UNO only): + +
+    uno::Reference somePostProcCode( MyClass * p );
+    [...]
+    namespace sdecl = comphelper::service_decl;
+    sdecl::ServiceDecl const myDecl(
+        sdecl::class_(&somePostProcCode),
+        "my.unique.implementation.name",
+        "MyServiceSpec1;MyServiceSpec2" );
+    
+ + In the latter case, somePostProcCode gets the yet unacquired "raw" pointer. +*/ +class COMPHELPER_DLLPUBLIC ServiceDecl +{ +public: + /** Ctor for multiple supported service names. + + @param implClass implementation class description + @param pImplName implementation name + @param pSupportedServiceNames supported service names + @param cDelim delimiter for supported service names + */ + ServiceDecl( const ServiceDecl& ) = delete; + ServiceDecl& operator=( const ServiceDecl& ) = delete; + template + ServiceDecl( ImplClassT const& implClass, + char const* pImplName, + char const* pSupportedServiceNames ) + : m_createFunc(implClass.m_createFunc), + m_pImplName(pImplName), + m_pServiceNames(pSupportedServiceNames) {} + + /// @internal gets called by component_getFactoryHelper() + void * getFactory( char const* pImplName ) const; + + /// @return supported service names + css::uno::Sequence< OUString> getSupportedServiceNames() const; + + /// @return whether name is in set of supported service names + bool supportsService( std::u16string_view name ) const; + + /// @return implementation name + OUString getImplementationName() const; + +private: + class Factory; + friend class Factory; + + detail::CreateFuncF const m_createFunc; + char const* const m_pImplName; + char const* const m_pServiceNames; +}; + +/** To specify whether the implementation class expects arguments + (uno::Sequence). +*/ +template struct with_args; + +/// @internal +namespace detail { + +} // namespace detail + + +COMPHELPER_DLLPUBLIC +void* component_getFactoryHelper( const char* pImplName, + std::initializer_list args ); + +} // namespace comphelper::service_decl + + +#endif // ! defined( INCLUDED_COMPHELPER_SERVICEDECL_HXX) + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3