Mohamed Ali
3d75577640
Implements LibreOffice extension providing Rust language binding for UNO API using opaque pointer FFI architecture with type-safe handles. Extension Features: - User-controlled execution via "Rust UNO → Example" menu - Optional installation/removal through LibreOffice extension system - Complete Writer document manipulation example Technical Implementation: - Generated Rust wrappers for all UNO types via rustmaker - C++ extern "C" bridges with proper UNO integration - Type-safe opaque handles (XTextDocumentHandle, etc.) - Extension architecture following LibreOffice standards - Menu integration via Addons.xcu and ProtocolHandler.xcu Architecture: - Rust RAII Wrappers ↔ C++ extern "C" Bridges ↔ LibreOffice UNO - Extension packaging with rust_uno-example.oxt - Integrated build system with CustomTarget and Library makefiles Build Commands: ./configure --enable-rust-uno Extension Structure: - rust_uno/example/ - Extension source files - workdir/Extension/rust_uno-example.oxt - Packaged extension - Automatic installation during LibreOffice build Runtime Validation: Successfully demonstrates complete UNO integration: - Desktop service creation and XComponentLoader interface - Writer document loading via loadComponentFromURL - Text manipulation through XTextDocument and XSimpleText - Proper interface querying and method invocation GSoC 2025: Rust UNO Language Binding Change-Id: I5cecb8ebd05aab396f444488c0ee2a9d483a9f62 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/186425 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <stephan.bergmann@collabora.com>
244 lines
8.4 KiB
C++
244 lines
8.4 KiB
C++
/* -*- 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 .
|
|
*/
|
|
|
|
#include <sal/config.h>
|
|
|
|
#include <cassert>
|
|
|
|
#include <com/sun/star/beans/PropertyValue.hpp>
|
|
#include <com/sun/star/frame/DispatchDescriptor.hpp>
|
|
#include <com/sun/star/frame/Desktop.hpp>
|
|
#include <com/sun/star/frame/XDispatch.hpp>
|
|
#include <com/sun/star/frame/XDispatchProvider.hpp>
|
|
#include <com/sun/star/frame/XStatusListener.hpp>
|
|
#include <com/sun/star/lang/XServiceInfo.hpp>
|
|
#include <com/sun/star/uno/DeploymentException.hpp>
|
|
#include <com/sun/star/uno/Exception.hpp>
|
|
#include <com/sun/star/uno/Reference.hxx>
|
|
#include <com/sun/star/uno/RuntimeException.hpp>
|
|
#include <com/sun/star/uno/Sequence.hxx>
|
|
#include <com/sun/star/uno/XComponentContext.hpp>
|
|
#include <com/sun/star/uno/XInterface.hpp>
|
|
#include <com/sun/star/util/URL.hpp>
|
|
#include <cppuhelper/factory.hxx>
|
|
#include <cppuhelper/implbase2.hxx>
|
|
#include <cppuhelper/implementationentry.hxx>
|
|
#include <cppuhelper/supportsservice.hxx>
|
|
#include <cppuhelper/weak.hxx>
|
|
#include <rtl/ustring.hxx>
|
|
#include <sal/log.hxx>
|
|
#include <sal/types.h>
|
|
#include <uno/lbnames.h>
|
|
|
|
#include "rust_uno_hook.hxx"
|
|
|
|
namespace
|
|
{
|
|
class Provider
|
|
: public cppu::WeakImplHelper2<css::lang::XServiceInfo, css::frame::XDispatchProvider>
|
|
{
|
|
public:
|
|
Provider(const Provider&) = delete;
|
|
const Provider& operator=(const Provider&) = delete;
|
|
|
|
static css::uno::Reference<css::uno::XInterface>
|
|
SAL_CALL static_create(css::uno::Reference<css::uno::XComponentContext> const& xContext)
|
|
{
|
|
return static_cast<cppu::OWeakObject*>(new Provider(xContext));
|
|
}
|
|
|
|
static rtl::OUString SAL_CALL static_getImplementationName();
|
|
|
|
static css::uno::Sequence<rtl::OUString> SAL_CALL static_getSupportedServiceNames();
|
|
|
|
private:
|
|
explicit Provider(css::uno::Reference<css::uno::XComponentContext> const& context)
|
|
: context_(context)
|
|
{
|
|
assert(context.is());
|
|
}
|
|
|
|
virtual ~Provider() {}
|
|
|
|
virtual rtl::OUString SAL_CALL getImplementationName() override
|
|
{
|
|
return static_getImplementationName();
|
|
}
|
|
|
|
virtual sal_Bool SAL_CALL supportsService(rtl::OUString const& ServiceName) override
|
|
{
|
|
return cppu::supportsService(this, ServiceName);
|
|
}
|
|
|
|
virtual css::uno::Sequence<rtl::OUString> SAL_CALL getSupportedServiceNames() override
|
|
{
|
|
return static_getSupportedServiceNames();
|
|
}
|
|
|
|
virtual css::uno::Reference<css::frame::XDispatch>
|
|
SAL_CALL queryDispatch(css::util::URL const&, rtl::OUString const&, sal_Int32) override;
|
|
|
|
virtual css::uno::Sequence<css::uno::Reference<css::frame::XDispatch>> SAL_CALL
|
|
queryDispatches(css::uno::Sequence<css::frame::DispatchDescriptor> const& Requests) override;
|
|
|
|
css::uno::Reference<css::uno::XComponentContext> context_;
|
|
};
|
|
|
|
rtl::OUString Provider::static_getImplementationName()
|
|
{
|
|
return rtl::OUString("org.libreoffice.comp.rust_uno.example");
|
|
}
|
|
|
|
css::uno::Sequence<rtl::OUString> Provider::static_getSupportedServiceNames()
|
|
{
|
|
rtl::OUString name("org.libreoffice.rust_uno.example");
|
|
return css::uno::Sequence<rtl::OUString>(&name, 1);
|
|
}
|
|
|
|
css::uno::Reference<css::frame::XDispatch> Provider::queryDispatch(css::util::URL const&,
|
|
rtl::OUString const&, sal_Int32)
|
|
{
|
|
css::uno::Reference<css::frame::XDispatch> dispatch;
|
|
if (!(context_->getValueByName("/singletons/org.libreoffice.rust_uno.example_singleton")
|
|
>>= dispatch)
|
|
|| !dispatch.is())
|
|
{
|
|
throw css::uno::DeploymentException("component context fails to supply singleton "
|
|
"org.libreoffice.rust_uno.example_singleton of type "
|
|
"com.sun.star.frame.XDispatch",
|
|
context_);
|
|
}
|
|
return dispatch;
|
|
}
|
|
|
|
css::uno::Sequence<css::uno::Reference<css::frame::XDispatch>>
|
|
Provider::queryDispatches(css::uno::Sequence<css::frame::DispatchDescriptor> const& Requests)
|
|
{
|
|
css::uno::Sequence<css::uno::Reference<css::frame::XDispatch>> s(Requests.getLength());
|
|
for (sal_Int32 i = 0; i < s.getLength(); ++i)
|
|
{
|
|
s[i]
|
|
= queryDispatch(Requests[i].FeatureURL, Requests[i].FrameName, Requests[i].SearchFlags);
|
|
}
|
|
return s;
|
|
}
|
|
|
|
class Dispatch : public cppu::WeakImplHelper2<css::lang::XServiceInfo, css::frame::XDispatch>
|
|
{
|
|
public:
|
|
Dispatch(const Dispatch&) = delete;
|
|
const Dispatch& operator=(const Dispatch&) = delete;
|
|
|
|
static css::uno::Reference<css::uno::XInterface>
|
|
SAL_CALL static_create(css::uno::Reference<css::uno::XComponentContext> const& xContext)
|
|
{
|
|
return static_cast<cppu::OWeakObject*>(new Dispatch(xContext));
|
|
}
|
|
|
|
static rtl::OUString SAL_CALL static_getImplementationName();
|
|
|
|
static css::uno::Sequence<rtl::OUString> SAL_CALL static_getSupportedServiceNames()
|
|
{
|
|
return css::uno::Sequence<rtl::OUString>();
|
|
}
|
|
|
|
private:
|
|
explicit Dispatch(css::uno::Reference<css::uno::XComponentContext> const& context)
|
|
: context_(context)
|
|
{
|
|
assert(context.is());
|
|
}
|
|
|
|
virtual ~Dispatch() {}
|
|
|
|
virtual rtl::OUString SAL_CALL getImplementationName() override
|
|
{
|
|
return static_getImplementationName();
|
|
}
|
|
|
|
virtual sal_Bool SAL_CALL supportsService(rtl::OUString const& ServiceName) override
|
|
{
|
|
return cppu::supportsService(this, ServiceName);
|
|
}
|
|
|
|
virtual css::uno::Sequence<rtl::OUString> SAL_CALL getSupportedServiceNames() override
|
|
{
|
|
return static_getSupportedServiceNames();
|
|
}
|
|
|
|
virtual void SAL_CALL dispatch(css::util::URL const&,
|
|
css::uno::Sequence<css::beans::PropertyValue> const&) override;
|
|
|
|
virtual void SAL_CALL addStatusListener(css::uno::Reference<css::frame::XStatusListener> const&,
|
|
css::util::URL const&) override
|
|
{
|
|
}
|
|
|
|
virtual void SAL_CALL removeStatusListener(
|
|
css::uno::Reference<css::frame::XStatusListener> const&, css::util::URL const&) override
|
|
{
|
|
}
|
|
|
|
css::uno::Reference<css::uno::XComponentContext> context_;
|
|
};
|
|
|
|
rtl::OUString Dispatch::static_getImplementationName()
|
|
{
|
|
return rtl::OUString("org.libreoffice.comp.rust_uno.example_singleton");
|
|
}
|
|
|
|
void Dispatch::dispatch(css::util::URL const&, css::uno::Sequence<css::beans::PropertyValue> const&)
|
|
{
|
|
// === RUST UNO BINDING TEST ===
|
|
// Call our Rust UNO binding to test it works within LibreOffice
|
|
SAL_INFO("desktop.app", "Testing Rust UNO binding...");
|
|
try
|
|
{
|
|
run_rust_uno_test();
|
|
SAL_INFO("desktop.app", "Rust UNO binding test completed successfully!");
|
|
}
|
|
catch (...)
|
|
{
|
|
SAL_WARN("desktop.app", "Rust UNO binding test failed!");
|
|
}
|
|
}
|
|
|
|
cppu::ImplementationEntry const services[] = {
|
|
{ &Provider::static_create, &Provider::static_getImplementationName,
|
|
&Provider::static_getSupportedServiceNames, &cppu::createSingleComponentFactory, nullptr, 0 },
|
|
{ &Dispatch::static_create, &Dispatch::static_getImplementationName,
|
|
&Dispatch::static_getSupportedServiceNames, &cppu::createSingleComponentFactory, nullptr, 0 },
|
|
{ nullptr, nullptr, nullptr, nullptr, nullptr, 0 }
|
|
};
|
|
}
|
|
|
|
extern "C" SAL_DLLPUBLIC_EXPORT void*
|
|
component_getFactory(char const* pImplName, void* pServiceManager, void* pRegistryKey)
|
|
{
|
|
return cppu::component_getFactoryHelper(pImplName, pServiceManager, pRegistryKey, services);
|
|
}
|
|
|
|
extern "C" SAL_DLLPUBLIC_EXPORT void
|
|
component_getImplementationEnvironment(char const** ppEnvTypeName, uno_Environment**)
|
|
{
|
|
*ppEnvTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME;
|
|
}
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */
|