configmgr/source/components.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 #ifndef INCLUDED_CONFIGMGR_SOURCE_COMPONENTS_HXX
  21 #define INCLUDED_CONFIGMGR_SOURCE_COMPONENTS_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <memory>
  26 #include <set>
  27
  28 #include <com/sun/star/beans/Optional.hpp>
  29 #include <com/sun/star/uno/Reference.hxx>
  30 #include <rtl/ref.hxx>
  31
  32 #include "additions.hxx"
  33 #include "data.hxx"
  34 #include "modifications.hxx"
  35
  36 namespace com { namespace sun { namespace star {
  37     namespace beans { class XPropertySet; }
  38     namespace uno {
  39         class Any;
  40         class XComponentContext;
  41     }
  42 } } }
  43
  44 namespace configmgr {
  45
  46 class Broadcaster;
  47 class Node;
  48 class Partial;
  49 class RootAccess;
  50
  51 class Components {
  52 public:
  53     static Components & getSingleton(
  54         css::uno::Reference< css::uno::XComponentContext > const & context);
  55
  56     static bool allLocales(OUString const & locale);
  57
  58     rtl::Reference< Node > resolvePathRepresentation(
  59         OUString const & pathRepresentation,
  60         OUString * canonicRepresenation, std::vector<OUString> * path, int * finalizedLayer)
  61         const;
  62
  63     rtl::Reference< Node > getTemplate( OUString const & fullName) const;
  64
  65     void addRootAccess(rtl::Reference< RootAccess > const & access);
  66
  67     void removeRootAccess(RootAccess * access);
  68
  69     void initGlobalBroadcaster(
  70         Modifications const & modifications,
  71         rtl::Reference< RootAccess > const & exclude,
  72         Broadcaster * broadcaster);
  73
  74     void addModification(std::vector<OUString> const & path);
  75
  76     void writeModifications();
  77
  78     void flushModifications();
  79         // must be called with configmgr::lock unacquired; must be called before
  80         // shutdown if writeModifications has ever been called (probably
  81         // indirectly, via removeExtensionXcuFile)
  82
  83     void insertExtensionXcsFile(bool shared, OUString const & fileUri);
  84
  85     void insertExtensionXcuFile(
  86         bool shared, OUString const & fileUri,
  87         Modifications * modifications);
  88
  89     void removeExtensionXcuFile(
  90         OUString const & fileUri, Modifications * modifications);
  91
  92     void insertModificationXcuFile(
  93         OUString const & fileUri,
  94         std::set< OUString > const & includedPaths,
  95         std::set< OUString > const & excludedPaths,
  96         Modifications * modifications);
  97
  98     css::beans::Optional< css::uno::Any >
  99     getExternalValue(OUString const & descriptor);
 100
 101 private:
 102     Components(const Components&) = delete;
 103     Components& operator=(const Components&) = delete;
 104
 105     typedef void FileParser(
 106         OUString const &, int, Data &, Partial const *, Modifications *,
 107         Additions *);
 108 public:
 109     explicit Components(
 110         css::uno::Reference< css::uno::XComponentContext > const & context);
 111
 112     ~Components();
 113 private:
 114
 115     void parseFileLeniently(
 116         FileParser * parseFile, OUString const & url, int layer,
 117         Partial const * partial, Modifications * modifications,
 118         Additions * additions);
 119
 120     void parseFiles(
 121         int layer, OUString const & extension, FileParser * parseFile,
 122         OUString const & url, bool recursive);
 123
 124     void parseFileList(
 125         int layer, FileParser * parseFile, OUString const & urls,
 126         bool recordAdditions);
 127
 128     void parseXcdFiles(int layer, OUString const & url);
 129
 130     void parseXcsXcuLayer(int layer, OUString const & url);
 131
 132     void parseXcsXcuIniLayer(
 133         int layer, OUString const & url, bool recordAdditions);
 134
 135     void parseModuleLayer(int layer, OUString const & url);
 136
 137     void parseResLayer(int layer, OUString const & url);
 138
 139     void parseModificationLayer(int layer, OUString const & url);
 140
 141     int getExtensionLayer(bool shared) const;
 142
 143     typedef std::set< RootAccess * > WeakRootSet;
 144
 145     typedef
 146         config_map<
 147             css::uno::Reference<
 148                 css::beans::XPropertySet > >
 149         ExternalServices;
 150
 151     class WriteThread;
 152
 153     enum class ModificationTarget { None, File, Dconf };
 154
 155     css::uno::Reference< css::uno::XComponentContext >
 156         context_;
 157     Data data_;
 158     WeakRootSet roots_;
 159     ExternalServices externalServices_;
 160     rtl::Reference< WriteThread > writeThread_;
 161     int sharedExtensionLayer_;
 162     int userExtensionLayer_;
 163     ModificationTarget modificationTarget_;
 164     OUString modificationFileUrl_;
 165     std::shared_ptr<osl::Mutex> lock_;
 166 };
 167
 168 }
 169
 170 #endif
 171
 172 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */