binaryurp/source/bridge.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <sal/config.h>
  23
  24 #include <cstddef>
  25 #include <map>
  26 #include <vector>
  27
  28 #include <com/sun/star/bridge/XBridge.hpp>
  29 #include <com/sun/star/lang/XComponent.hpp>
  30 #include <com/sun/star/uno/Reference.hxx>
  31 #include <cppuhelper/implbase.hxx>
  32 #include <osl/conditn.hxx>
  33 #include <osl/mutex.hxx>
  34 #include <rtl/ref.hxx>
  35 #include <rtl/ustring.hxx>
  36 #include <sal/types.h>
  37 #include <uno/environment.hxx>
  38 #include <uno/mapping.hxx>
  39 #include <uno/threadpool.h>
  40
  41 #include "outgoingrequest.hxx"
  42 #include "outgoingrequests.hxx"
  43 #include "writer.hxx"
  44
  45 namespace binaryurp {
  46     class BinaryAny;
  47     class BridgeFactory;
  48     class Proxy;
  49     class Reader;
  50 }
  51 namespace com::sun::star {
  52     namespace bridge { class XInstanceProvider; }
  53     namespace connection { class XConnection; }
  54     namespace lang { class XEventListener; }
  55     namespace uno {
  56         class Any;
  57         class TypeDescription;
  58         class UnoInterfaceReference;
  59         class XInterface;
  60     }
  61 }
  62 namespace rtl { class ByteSequence; }
  63
  64 namespace binaryurp {
  65
  66 class Bridge:
  67     public cppu::WeakImplHelper<
  68         com::sun::star::bridge::XBridge, com::sun::star::lang::XComponent >
  69 {
  70 public:
  71     Bridge(
  72         rtl::Reference< BridgeFactory > const & factory,
  73         OUString const & name,
  74         com::sun::star::uno::Reference<
  75             com::sun::star::connection::XConnection > const & connection,
  76         com::sun::star::uno::Reference<
  77             com::sun::star::bridge::XInstanceProvider > const & provider);
  78
  79     void start();
  80
  81     // Internally waits for all incoming and outgoing remote calls to terminate,
  82     // so must not be called from within such a call; when final is true, also
  83     // joins all remaining threads (reader, writer, and worker threads from the
  84     // thread pool), so must not be called with final set to true from such a
  85     // thread:
  86     void terminate(bool final);
  87
  88     const com::sun::star::uno::Reference< com::sun::star::connection::XConnection >&
  89     getConnection() const { return connection_;}
  90
  91     const com::sun::star::uno::Reference< com::sun::star::bridge::XInstanceProvider >&
  92     getProvider() const { return provider_;}
  93
  94     com::sun::star::uno::Mapping & getCppToBinaryMapping() { return cppToBinaryMapping_;}
  95
  96     BinaryAny mapCppToBinaryAny(com::sun::star::uno::Any const & cppAny);
  97
  98     uno_ThreadPool getThreadPool();
  99
 100     rtl::Reference< Writer > getWriter();
 101
 102     com::sun::star::uno::UnoInterfaceReference registerIncomingInterface(
 103         OUString const & oid,
 104         com::sun::star::uno::TypeDescription const & type);
 105
 106     OUString registerOutgoingInterface(
 107         com::sun::star::uno::UnoInterfaceReference const & object,
 108         com::sun::star::uno::TypeDescription const & type);
 109
 110     com::sun::star::uno::UnoInterfaceReference findStub(
 111         OUString const & oid,
 112         com::sun::star::uno::TypeDescription const & type);
 113
 114     void releaseStub(
 115         OUString const & oid,
 116         com::sun::star::uno::TypeDescription const & type);
 117
 118     void resurrectProxy(Proxy & proxy);
 119
 120     void revokeProxy(Proxy & proxy);
 121
 122     void freeProxy(Proxy & proxy);
 123
 124     void incrementCalls(bool normalCall) noexcept;
 125
 126     void decrementCalls();
 127
 128     void incrementActiveCalls() noexcept;
 129
 130     void decrementActiveCalls() noexcept;
 131
 132     bool makeCall(
 133         OUString const & oid,
 134         com::sun::star::uno::TypeDescription const & member, bool setter,
 135         std::vector< BinaryAny >&& inArguments, BinaryAny * returnValue,
 136         std::vector< BinaryAny > * outArguments);
 137
 138     // Only called from reader_ thread:
 139     void sendRequestChangeRequest();
 140
 141     // Only called from reader_ thread:
 142     void handleRequestChangeReply(
 143         bool exception, BinaryAny const & returnValue);
 144
 145     // Only called from reader_ thread:
 146     void handleCommitChangeReply(bool exception, BinaryAny const & returnValue);
 147
 148     // Only called from reader_ thread:
 149     void handleRequestChangeRequest(
 150         rtl::ByteSequence const & tid,
 151         std::vector< BinaryAny > const & inArguments);
 152
 153     // Only called from reader_ thread:
 154     void handleCommitChangeRequest(
 155         rtl::ByteSequence const & tid,
 156         std::vector< BinaryAny > const & inArguments);
 157
 158     OutgoingRequest lastOutgoingRequest(rtl::ByteSequence const & tid);
 159
 160     bool isProtocolPropertiesRequest(
 161         std::u16string_view oid,
 162         com::sun::star::uno::TypeDescription const & type) const;
 163
 164     void setCurrentContextMode();
 165
 166     bool isCurrentContextMode();
 167
 168 private:
 169     Bridge(const Bridge&) = delete;
 170     Bridge& operator=(const Bridge&) = delete;
 171
 172     virtual ~Bridge() override;
 173
 174     virtual com::sun::star::uno::Reference< com::sun::star::uno::XInterface >
 175     SAL_CALL getInstance(OUString const & sInstanceName) override;
 176
 177     virtual OUString SAL_CALL getName() override;
 178
 179     virtual OUString SAL_CALL getDescription() override;
 180
 181     virtual void SAL_CALL dispose() override;
 182
 183     virtual void SAL_CALL addEventListener(
 184         com::sun::star::uno::Reference< com::sun::star::lang::XEventListener >
 185             const & xListener) override;
 186
 187     virtual void SAL_CALL removeEventListener(
 188         com::sun::star::uno::Reference< com::sun::star::lang::XEventListener >
 189             const & aListener) override;
 190
 191     // Only called from reader_ thread:
 192     void sendCommitChangeRequest();
 193
 194     // Only called from reader_ thread:
 195     void sendProtPropRequest(
 196         OutgoingRequest::Kind kind,
 197         std::vector< BinaryAny > const & inArguments);
 198
 199     void makeReleaseCall(
 200         OUString const & oid,
 201         com::sun::star::uno::TypeDescription const & type);
 202
 203     void sendRequest(
 204         rtl::ByteSequence const & tid, OUString const & oid,
 205         com::sun::star::uno::TypeDescription const & type,
 206         com::sun::star::uno::TypeDescription const & member,
 207         std::vector< BinaryAny >&& inArguments);
 208
 209     void throwException(bool exception, BinaryAny const & value);
 210
 211     com::sun::star::uno::Any mapBinaryToCppAny(BinaryAny const & binaryAny);
 212
 213     bool becameUnused() const;
 214
 215     void terminateWhenUnused(bool unused);
 216
 217     // Must only be called with mutex_ locked:
 218     void checkDisposed();
 219
 220     typedef
 221         std::vector<
 222             com::sun::star::uno::Reference<
 223                 com::sun::star::lang::XEventListener > >
 224         Listeners;
 225
 226     struct SubStub;
 227
 228     typedef std::map< com::sun::star::uno::TypeDescription, SubStub > Stub;
 229
 230     typedef std::map< OUString, Stub > Stubs;
 231
 232     enum State { STATE_INITIAL, STATE_STARTED, STATE_TERMINATED, STATE_FINAL };
 233
 234     enum Mode {
 235         MODE_REQUESTED, MODE_REPLY_MINUS1, MODE_REPLY_0, MODE_REPLY_1,
 236         MODE_WAIT, MODE_NORMAL, MODE_NORMAL_WAIT };
 237
 238     rtl::Reference< BridgeFactory > factory_;
 239     OUString name_;
 240     com::sun::star::uno::Reference< com::sun::star::connection::XConnection >
 241         connection_;
 242     com::sun::star::uno::Reference< com::sun::star::bridge::XInstanceProvider >
 243         provider_;
 244     com::sun::star::uno::Environment binaryUno_;
 245     com::sun::star::uno::Mapping cppToBinaryMapping_;
 246     com::sun::star::uno::Mapping binaryToCppMapping_;
 247     rtl::ByteSequence protPropTid_;
 248     OUString protPropOid_;
 249     com::sun::star::uno::TypeDescription protPropType_;
 250     com::sun::star::uno::TypeDescription protPropRequest_;
 251     com::sun::star::uno::TypeDescription protPropCommit_;
 252     OutgoingRequests outgoingRequests_;
 253     osl::Condition passive_;
 254         // to guarantee that passive_ is eventually set (to avoid deadlock, see
 255         // dispose), activeCalls_ only counts those calls for which it can be
 256         // guaranteed that incrementActiveCalls is indeed followed by
 257         // decrementActiveCalls, without an intervening exception
 258     osl::Condition terminated_;
 259
 260     osl::Mutex mutex_;
 261     State state_;
 262     Listeners listeners_;
 263     uno_ThreadPool threadPool_;
 264     rtl::Reference< Writer > writer_;
 265     rtl::Reference< Reader > reader_;
 266     bool currentContextMode_;
 267     Stubs stubs_;
 268     std::size_t proxies_;
 269     std::size_t calls_;
 270     bool normalCall_;
 271     std::size_t activeCalls_;
 272
 273     // Only accessed from reader_ thread:
 274     Mode mode_;
 275     sal_Int32 random_;
 276 };
 277
 278 }
 279
 280 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */