configmgr/source/access.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 <set>
  25 #include <vector>
  26 #include <o3tl/sorted_vector.hxx>
  27 #include "config_map.hxx"
  28
  29 #include <com/sun/star/beans/XExactName.hpp>
  30 #include <com/sun/star/beans/XHierarchicalPropertySet.hpp>
  31 #include <com/sun/star/beans/XHierarchicalPropertySetInfo.hpp>
  32 #include <com/sun/star/beans/XMultiHierarchicalPropertySet.hpp>
  33 #include <com/sun/star/beans/XMultiPropertySet.hpp>
  34 #include <com/sun/star/beans/XProperty.hpp>
  35 #include <com/sun/star/beans/XPropertySet.hpp>
  36 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  37 #include <com/sun/star/container/XContainer.hpp>
  38 #include <com/sun/star/container/XHierarchicalName.hpp>
  39 #include <com/sun/star/container/XHierarchicalNameAccess.hpp>
  40 #include <com/sun/star/configuration/XDocumentation.hpp>
  41 #include <com/sun/star/container/XHierarchicalNameReplace.hpp>
  42 #include <com/sun/star/container/XNameContainer.hpp>
  43 #include <com/sun/star/container/XNamed.hpp>
  44 #include <com/sun/star/lang/XComponent.hpp>
  45 #include <com/sun/star/lang/XServiceInfo.hpp>
  46 #include <com/sun/star/lang/XTypeProvider.hpp>
  47 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  48 #include <com/sun/star/uno/Reference.hxx>
  49 #include <com/sun/star/uno/Sequence.hxx>
  50 #include <cppuhelper/weak.hxx>
  51 #include <osl/interlck.h>
  52 #include <rtl/ref.hxx>
  53 #include <sal/types.h>
  54
  55 #include "modifications.hxx"
  56 #include "type.hxx"
  57
  58 namespace com::sun::star {
  59     namespace beans {
  60         class XHierarchicalPropertySetInfo;
  61         class XPropertiesChangeListener;
  62         class XPropertyChangeListener;
  63         class XVetoableChangeListener;
  64         struct Property;
  65     }
  66     namespace container { class XContainerListener; }
  67     namespace lang { class XEventListener; }
  68     namespace uno {
  69         class Any;
  70         class Type;
  71         class XInterface;
  72     }
  73     namespace util { struct ElementChange; }
  74 }
  75
  76 namespace configmgr {
  77
  78 class Broadcaster;
  79 class ChildAccess;
  80 class Components;
  81 class Node;
  82 class RootAccess;
  83
  84 class Access:
  85     public cppu::OWeakObject, public css::lang::XTypeProvider,
  86     public css::lang::XServiceInfo,
  87     public css::lang::XComponent,
  88     public css::configuration::XDocumentation,
  89     public css::container::XHierarchicalNameReplace,
  90     public css::container::XContainer,
  91     public css::beans::XExactName,
  92     public css::beans::XPropertySetInfo,
  93     public css::container::XHierarchicalName,
  94     public css::container::XNamed,
  95     public css::beans::XProperty,
  96     public css::beans::XPropertySet,
  97     public css::beans::XMultiPropertySet,
  98     public css::beans::XHierarchicalPropertySet,
  99     public css::beans::XMultiHierarchicalPropertySet,
 100     public css::beans::XHierarchicalPropertySetInfo,
 101     public css::container::XNameContainer,
 102     public css::lang::XSingleServiceFactory
 103 {
 104 public:
 105     oslInterlockedCount acquireCounting();
 106
 107     void releaseNondeleting();
 108
 109     bool isValue();
 110
 111     void markChildAsModified(rtl::Reference< ChildAccess > const & child);
 112     void releaseChild(OUString const & name);
 113
 114     virtual std::vector<OUString> getAbsolutePath() = 0;
 115     virtual std::vector<OUString> getRelativePath() = 0;
 116
 117     virtual OUString getRelativePathRepresentation() = 0;
 118     virtual const rtl::Reference< Node > & getNode() = 0;
 119
 120     virtual bool isFinalized() = 0;
 121
 122     virtual void initBroadcaster(
 123         Modifications::Node const & modifications, Broadcaster * broadcaster);
 124
 125     using OWeakObject::acquire;
 126     using OWeakObject::release;
 127
 128     virtual css::uno::Sequence< css::uno::Type > SAL_CALL
 129     getTypes() override;
 130
 131     virtual css::uno::Sequence< sal_Int8 > SAL_CALL
 132     getImplementationId() override;
 133
 134     virtual OUString SAL_CALL getImplementationName() override;
 135
 136     virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override;
 137
 138     virtual css::uno::Sequence< OUString > SAL_CALL
 139     getSupportedServiceNames() override;
 140
 141     virtual void SAL_CALL dispose() override;
 142
 143     virtual void SAL_CALL addEventListener(
 144         css::uno::Reference< css::lang::XEventListener >
 145             const & xListener) override;
 146
 147     virtual void SAL_CALL removeEventListener(
 148         css::uno::Reference< css::lang::XEventListener >
 149             const & aListener) override;
 150
 151     virtual css::uno::Type SAL_CALL getElementType() override;
 152
 153     virtual sal_Bool SAL_CALL hasElements() override;
 154
 155     virtual css::uno::Any SAL_CALL getByName(
 156         OUString const & aName) override;
 157
 158     virtual css::uno::Sequence< OUString > SAL_CALL
 159     getElementNames() override;
 160
 161     virtual sal_Bool SAL_CALL hasByName(OUString const & aName) override;
 162
 163     virtual css::uno::Any SAL_CALL getByHierarchicalName(
 164         OUString const & aName) override;
 165
 166     virtual OUString SAL_CALL getDescriptionByHierarchicalName(
 167         OUString const & aName) override;
 168
 169     virtual css::uno::Type SAL_CALL getTypeByHierarchicalName(
 170         OUString const & aName) override;
 171
 172     virtual sal_Bool SAL_CALL getModifiedByHierarchicalName(
 173         OUString const & aName) override;
 174
 175     virtual sal_Bool SAL_CALL hasByHierarchicalName(OUString const & aName) override;
 176
 177     virtual void SAL_CALL replaceByHierarchicalName(
 178         OUString const & aName, css::uno::Any const & aElement) override;
 179
 180     virtual void SAL_CALL addContainerListener(
 181         css::uno::Reference<
 182             css::container::XContainerListener > const & xListener) override;
 183
 184     virtual void SAL_CALL removeContainerListener(
 185         css::uno::Reference<
 186             css::container::XContainerListener > const & xListener) override;
 187
 188     virtual OUString SAL_CALL getExactName(
 189         OUString const & aApproximateName) override;
 190
 191     virtual css::uno::Sequence< css::beans::Property >
 192     SAL_CALL getProperties() override;
 193
 194     virtual css::beans::Property SAL_CALL getPropertyByName(
 195         OUString const & aName) override;
 196
 197     virtual sal_Bool SAL_CALL hasPropertyByName(OUString const & Name) override;
 198
 199     virtual OUString SAL_CALL getHierarchicalName() override;
 200
 201     virtual OUString SAL_CALL composeHierarchicalName(
 202         OUString const & aRelativeName) override;
 203
 204     virtual OUString SAL_CALL getName() override;
 205
 206     virtual void SAL_CALL setName(OUString const & aName) override;
 207
 208     virtual css::beans::Property SAL_CALL getAsProperty() override;
 209
 210     virtual
 211     css::uno::Reference< css::beans::XPropertySetInfo >
 212     SAL_CALL getPropertySetInfo() override;
 213
 214     virtual void SAL_CALL setPropertyValue(
 215         OUString const & aPropertyName,
 216         css::uno::Any const & aValue) override;
 217
 218     virtual css::uno::Any SAL_CALL getPropertyValue(
 219         OUString const & PropertyName) override;
 220
 221     virtual void SAL_CALL addPropertyChangeListener(
 222         OUString const & aPropertyName,
 223         css::uno::Reference<
 224             css::beans::XPropertyChangeListener > const & xListener) override;
 225
 226     virtual void SAL_CALL removePropertyChangeListener(
 227         OUString const & aPropertyName,
 228         css::uno::Reference<
 229             css::beans::XPropertyChangeListener > const & aListener) override;
 230
 231     virtual void SAL_CALL addVetoableChangeListener(
 232         OUString const & PropertyName,
 233         css::uno::Reference<
 234             css::beans::XVetoableChangeListener > const & aListener) override;
 235
 236     virtual void SAL_CALL removeVetoableChangeListener(
 237         OUString const & PropertyName,
 238         css::uno::Reference<
 239             css::beans::XVetoableChangeListener > const & aListener) override;
 240
 241     virtual void SAL_CALL setPropertyValues(
 242         css::uno::Sequence< OUString > const & aPropertyNames,
 243         css::uno::Sequence< css::uno::Any > const &
 244             aValues) override;
 245
 246     virtual css::uno::Sequence< css::uno::Any > SAL_CALL
 247     getPropertyValues(
 248         css::uno::Sequence< OUString > const & aPropertyNames) override;
 249
 250     virtual void SAL_CALL addPropertiesChangeListener(
 251         css::uno::Sequence< OUString > const & aPropertyNames,
 252         css::uno::Reference<
 253             css::beans::XPropertiesChangeListener > const &
 254                 xListener) override;
 255
 256     virtual void SAL_CALL removePropertiesChangeListener(
 257         css::uno::Reference<
 258             css::beans::XPropertiesChangeListener > const &
 259                 xListener) override;
 260
 261     virtual void SAL_CALL firePropertiesChangeEvent(
 262         css::uno::Sequence< OUString > const & aPropertyNames,
 263         css::uno::Reference<
 264             css::beans::XPropertiesChangeListener > const &
 265                 xListener) override;
 266
 267     virtual
 268     css::uno::Reference<
 269         css::beans::XHierarchicalPropertySetInfo > SAL_CALL
 270     getHierarchicalPropertySetInfo() override;
 271
 272     virtual void SAL_CALL setHierarchicalPropertyValue(
 273         OUString const & aHierarchicalPropertyName,
 274         css::uno::Any const & aValue) override;
 275
 276     virtual css::uno::Any SAL_CALL getHierarchicalPropertyValue(
 277         OUString const & aHierarchicalPropertyName) override;
 278
 279     virtual void SAL_CALL setHierarchicalPropertyValues(
 280         css::uno::Sequence< OUString > const &
 281             aHierarchicalPropertyNames,
 282         css::uno::Sequence< css::uno::Any > const &
 283             Values) override;
 284
 285     virtual css::uno::Sequence< css::uno::Any > SAL_CALL
 286     getHierarchicalPropertyValues(
 287         css::uno::Sequence< OUString > const &
 288             aHierarchicalPropertyNames) override;
 289
 290     virtual css::beans::Property SAL_CALL
 291     getPropertyByHierarchicalName(OUString const & aHierarchicalName) override;
 292
 293     virtual sal_Bool SAL_CALL hasPropertyByHierarchicalName(
 294         OUString const & aHierarchicalName) override;
 295
 296     virtual void SAL_CALL replaceByName(
 297         OUString const & aName, css::uno::Any const & aElement) override;
 298
 299     virtual void SAL_CALL insertByName(
 300         OUString const & aName, css::uno::Any const & aElement) override;
 301
 302     virtual void SAL_CALL removeByName(OUString const & aName) override;
 303
 304     virtual css::uno::Reference< css::uno::XInterface >
 305     SAL_CALL createInstance() override;
 306
 307     virtual css::uno::Reference< css::uno::XInterface >
 308     SAL_CALL createInstanceWithArguments(
 309         css::uno::Sequence< css::uno::Any > const &
 310             aArguments) override;
 311
 312 protected:
 313     explicit Access(Components & components);
 314
 315     virtual ~Access() override;
 316
 317     virtual const OUString & getNameInternal() = 0;
 318     virtual rtl::Reference< RootAccess > getRootAccess() = 0;
 319     virtual rtl::Reference< Access > getParentAccess() = 0;
 320
 321     virtual void addTypes(std::vector< css::uno::Type > * types)
 322         const = 0;
 323
 324     virtual void addSupportedServiceNames(
 325         std::vector<OUString> * services) = 0;
 326
 327     virtual void initDisposeBroadcaster(Broadcaster * broadcaster);
 328     virtual void clearListeners() noexcept;
 329
 330     virtual css::uno::Any SAL_CALL queryInterface(
 331         css::uno::Type const & aType) override;
 332
 333     Components & getComponents() const { return components_;}
 334
 335     void checkLocalizedPropertyAccess();
 336
 337     rtl::Reference< Node > getParentNode();
 338     rtl::Reference< ChildAccess > getChild(OUString const & name);
 339     void forAllChildren(const std::function<bool(ChildAccess&)> & f);
 340     bool isAllChildrenEmpty();
 341
 342     void checkValue(
 343         css::uno::Any const & value, Type type, bool nillable);
 344
 345     void insertLocalizedValueChild(
 346         OUString const & name, css::uno::Any const & value,
 347         Modifications * localModifications);
 348
 349     void reportChildChanges(
 350         std::vector< css::util::ElementChange > * changes);
 351
 352     void commitChildChanges(bool valid, Modifications * globalModifications);
 353
 354     void initBroadcasterAndChanges(
 355         Modifications::Node const & modifications, Broadcaster * broadcaster,
 356         std::vector< css::util::ElementChange > * changes);
 357
 358     bool isDisposed() const { return disposed_;}
 359
 360 private:
 361     Access(const Access&) = delete;
 362     Access& operator=(const Access&) = delete;
 363
 364     struct ModifiedChild {
 365         rtl::Reference< ChildAccess > child;
 366         bool directlyModified;
 367
 368         ModifiedChild();
 369
 370         ModifiedChild(
 371             rtl::Reference< ChildAccess > theChild,
 372             bool theDirectlyModified);
 373     };
 374
 375     typedef config_map< ModifiedChild > ModifiedChildren;
 376
 377     rtl::Reference< ChildAccess > getModifiedChild(
 378         ModifiedChildren::iterator const & childIterator);
 379
 380     rtl::Reference< ChildAccess > getUnmodifiedChild(
 381         OUString const & name);
 382
 383     rtl::Reference< ChildAccess > getSubChild(OUString const & path);
 384
 385     bool setChildProperty(
 386         OUString const & name, css::uno::Any const & value,
 387         Modifications * localModifications);
 388
 389     css::beans::Property asProperty();
 390
 391     bool getByNameFast(const OUString & name, css::uno::Any & value);
 392     rtl::Reference< ChildAccess > createUnmodifiedChild(const OUString &name,
 393                                                         const rtl::Reference< Node > &node);
 394
 395     void checkFinalized();
 396
 397     void checkKnownProperty(OUString const & descriptor);
 398
 399     rtl::Reference< ChildAccess > getFreeSetMember( css::uno::Any const & value);
 400
 401     rtl::Reference< Access > getNotificationRoot();
 402
 403     typedef config_map< ChildAccess * > WeakChildMap;
 404
 405     typedef
 406         o3tl::sorted_vector<
 407             css::uno::Reference<
 408                 css::lang::XEventListener > >
 409         DisposeListeners;
 410
 411     typedef
 412         o3tl::sorted_vector<
 413             css::uno::Reference<
 414                 css::container::XContainerListener > >
 415         ContainerListeners;
 416
 417     typedef
 418         o3tl::sorted_vector<
 419             css::uno::Reference<
 420                 css::beans::XPropertyChangeListener > >
 421         PropertyChangeListenersElement;
 422
 423     typedef config_map< PropertyChangeListenersElement >
 424         PropertyChangeListeners;
 425
 426     typedef
 427         o3tl::sorted_vector<
 428             css::uno::Reference<
 429                 css::beans::XVetoableChangeListener > >
 430         VetoableChangeListenersElement;
 431
 432     typedef config_map< VetoableChangeListenersElement >
 433         VetoableChangeListeners;
 434
 435     typedef
 436         o3tl::sorted_vector<
 437             css::uno::Reference<
 438                 css::beans::XPropertiesChangeListener > >
 439         PropertiesChangeListeners;
 440
 441     Components & components_;
 442     ModifiedChildren modifiedChildren_;
 443     WeakChildMap cachedChildren_;
 444     DisposeListeners disposeListeners_;
 445     ContainerListeners containerListeners_;
 446     PropertyChangeListeners propertyChangeListeners_;
 447     VetoableChangeListeners vetoableChangeListeners_;
 448     PropertiesChangeListeners propertiesChangeListeners_;
 449     bool disposed_;
 450
 451     std::shared_ptr<osl::Mutex> lock_;
 452
 453 #if !defined NDEBUG
 454 protected:
 455     enum {
 456         IS_ANY = 0, IS_GROUP = 0x01, IS_SET = 0x02, IS_EXTENSIBLE = 0x04,
 457         IS_GROUP_MEMBER = 0x08, IS_SET_MEMBER = 0x10, IS_UPDATE = 0x20 };
 458     bool thisIs(int what);
 459 #endif
 460 };
 461
 462 }
 463
 464 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */