include/unotools/configmgr.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_UNOTOOLS_CONFIGMGR_HXX
  21 #define INCLUDED_UNOTOOLS_CONFIGMGR_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <string_view>
  26 #include <vector>
  27
  28 #include <com/sun/star/uno/Reference.hxx>
  29 #include <sal/types.h>
  30 #include <unotools/unotoolsdllapi.h>
  31
  32 namespace com::sun::star::container {
  33     class XHierarchicalNameAccess;
  34 }
  35 namespace utl { class ConfigItem; }
  36
  37 namespace utl {
  38
  39 class UNOTOOLS_DLLPUBLIC ConfigManager {
  40 public:
  41     static OUString getAboutBoxProductVersion();
  42
  43     static OUString getAboutBoxProductVersionSuffix();
  44
  45     static OUString getDefaultCurrency();
  46
  47     static OUString getUILocale();
  48
  49     static OUString getWorkLocale();
  50
  51     static OUString getProductExtension();
  52
  53     static OUString getProductName();
  54
  55     static OUString getProductVersion();
  56
  57     static OUString getVendor();
  58
  59     static void storeConfigItems();
  60
  61     SAL_DLLPRIVATE static ConfigManager & getConfigManager();
  62
  63     SAL_DLLPRIVATE static css::uno::Reference< css::container::XHierarchicalNameAccess>
  64     acquireTree(utl::ConfigItem const & item);
  65
  66     static css::uno::Reference< css::container::XHierarchicalNameAccess>
  67     acquireTree(std::u16string_view rSubTreeName);
  68
  69     SAL_DLLPRIVATE ConfigManager();
  70
  71     SAL_DLLPRIVATE ~ConfigManager();
  72
  73     SAL_DLLPRIVATE css::uno::Reference< css::container::XHierarchicalNameAccess >
  74     addConfigItem(utl::ConfigItem & item);
  75
  76     SAL_DLLPRIVATE void removeConfigItem(utl::ConfigItem & item);
  77
  78     SAL_DLLPRIVATE void registerConfigItem(utl::ConfigItem * item);
  79
  80     // Avoid using the config layer and rely on defaults which is only useful
  81     // for special test tool targets (typically fuzzing) where start-up speed
  82     // is of the essence
  83 #if defined(FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION)
  84     static constexpr bool IsFuzzing() { return true; }
  85 #else
  86     static bool IsFuzzing();
  87 #endif
  88     static void EnableFuzzing();
  89
  90 private:
  91
  92     ConfigManager(const ConfigManager&) = delete;
  93     ConfigManager& operator=(const ConfigManager&) = delete;
  94
  95     void doStoreConfigItems();
  96
  97     std::vector< ConfigItem * > items_;
  98 };
  99
 100 }
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */