registry/source/regimpl.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 <string_view>
  25 #include <unordered_map>
  26
  27 #include <regapi.hxx>
  28 #include <registry/regtype.h>
  29 #include <rtl/ustring.hxx>
  30 #include <osl/mutex.hxx>
  31 #include <store/store.hxx>
  32
  33 // 5 bytes = 1 (byte for the type) + 4 (bytes for the size of the data)
  34 #define VALUE_HEADERSIZE    5
  35 #define VALUE_TYPEOFFSET    1
  36 #define VALUE_HEADEROFFSET  5
  37
  38 #define REG_GUARD(mutex) \
  39     osl::Guard< osl::Mutex > aGuard( mutex );
  40
  41 class ORegKey;
  42
  43 class ORegistry
  44 {
  45 public:
  46     ORegistry();
  47
  48     sal_uInt32  acquire()
  49         { return ++m_refCount; }
  50
  51     sal_uInt32  release()
  52         { return --m_refCount; }
  53
  54     RegError    initRegistry(const OUString& name,
  55                              RegAccessMode accessMode,
  56                              bool bCreate = false);
  57
  58     RegError    closeRegistry();
  59
  60     RegError    destroyRegistry(const OUString& name);
  61
  62     RegError    acquireKey(RegKeyHandle hKey);
  63     RegError    releaseKey(RegKeyHandle hKey);
  64
  65     RegError    createKey(RegKeyHandle hKey,
  66                           std::u16string_view keyName,
  67                           RegKeyHandle* phNewKey);
  68
  69     RegError    openKey(RegKeyHandle hKey,
  70                         std::u16string_view keyName,
  71                         RegKeyHandle* phOpenKey);
  72
  73     RegError    closeKey(RegKeyHandle hKey);
  74
  75     RegError    deleteKey(RegKeyHandle hKey, std::u16string_view keyName);
  76
  77     RegError    dumpRegistry(RegKeyHandle hKey) const;
  78
  79     ~ORegistry();
  80
  81     bool            isReadOnly() const
  82         { return m_readOnly; }
  83
  84     bool            isOpen() const
  85         { return m_isOpen; }
  86
  87     ORegKey*    getRootKey();
  88
  89     const store::OStoreFile& getStoreFile() const
  90         { return m_file; }
  91
  92     const OUString&    getName() const
  93         { return m_name; }
  94
  95     friend class ORegKey;
  96
  97 private:
  98     RegError    eraseKey(ORegKey* pKey, std::u16string_view keyName);
  99
 100     RegError    deleteSubkeysAndValues(ORegKey* pKey);
 101
 102     RegError    dumpValue(const OUString& sPath,
 103                           const OUString& sName,
 104                           sal_Int16 nSpace) const;
 105
 106     RegError    dumpKey(const OUString& sPath,
 107                         const OUString& sName,
 108                         sal_Int16 nSpace) const;
 109
 110     typedef std::unordered_map< OUString, ORegKey* > KeyMap;
 111
 112     sal_uInt32          m_refCount;
 113     osl::Mutex          m_mutex;
 114     bool                m_readOnly;
 115     bool                m_isOpen;
 116     OUString            m_name;
 117     store::OStoreFile   m_file;
 118     KeyMap              m_openKeyTable;
 119
 120     static constexpr OUStringLiteral ROOT { u"/" };
 121 };
 122
 123 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */