include/xmloff/nmspmap.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_XMLOFF_NMSPMAP_HXX
  21 #define INCLUDED_XMLOFF_NMSPMAP_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <map>
  26 #include <unordered_map>
  27 #include <utility>
  28
  29 #include <xmloff/dllapi.h>
  30 #include <sal/types.h>
  31 #include <rtl/ustring.hxx>
  32 #include <rtl/ref.hxx>
  33 #include <cppuhelper/weak.hxx>
  34
  35 #include <limits.h>
  36
  37 const sal_uInt16 XML_NAMESPACE_XMLNS  = (USHRT_MAX-2);
  38 const sal_uInt16 XML_NAMESPACE_NONE  = (USHRT_MAX-1);
  39 const sal_uInt16 XML_NAMESPACE_UNKNOWN  = (USHRT_MAX);
  40 const sal_uInt16 XML_NAMESPACE_UNKNOWN_FLAG  = 0x8000;
  41
  42 class NameSpaceEntry : public cppu::OWeakObject
  43 {
  44 public:
  45     // sName refers to the full namespace name
  46     OUString     sName;
  47     // sPrefix is the prefix used to declare a given item to be from a given namespace
  48     OUString     sPrefix;
  49     // nKey is the unique identifier of a namespace
  50     sal_uInt16          nKey;
  51 };
  52
  53 typedef ::std::pair < sal_uInt16, OUString > QNamePair;
  54
  55 struct QNamePairHash
  56 {
  57     size_t operator()( const QNamePair &r1 ) const
  58     {
  59         return (size_t) r1.second.hashCode() + r1.first;
  60     }
  61 };
  62
  63 typedef std::unordered_map < QNamePair, OUString, QNamePairHash > QNameCache;
  64 typedef std::unordered_map < OUString, ::rtl::Reference <NameSpaceEntry >, OUStringHash > NameSpaceHash;
  65 typedef std::map < sal_uInt16, ::rtl::Reference < NameSpaceEntry > > NameSpaceMap;
  66
  67 class XMLOFF_DLLPUBLIC SvXMLNamespaceMap
  68 {
  69     const OUString       sXMLNS;
  70     const OUString       sEmpty;
  71
  72     NameSpaceHash               aNameHash;
  73     mutable NameSpaceHash       aNameCache;
  74     NameSpaceMap                aNameMap;
  75     mutable QNameCache          aQNameCache;
  76     SAL_DLLPRIVATE sal_uInt16 Add_( const OUString& rPrefix, const OUString &rName, sal_uInt16 nKey );
  77
  78 public:
  79
  80     SvXMLNamespaceMap();
  81     ~SvXMLNamespaceMap();
  82
  83     SvXMLNamespaceMap( const SvXMLNamespaceMap& );
  84
  85     SvXMLNamespaceMap& operator =( const SvXMLNamespaceMap& rCmp );
  86     bool operator ==( const SvXMLNamespaceMap& rCmp ) const;
  87
  88     sal_uInt16 Add( const OUString& rPrefix,
  89                 const OUString& rName,
  90                 sal_uInt16 nKey = XML_NAMESPACE_UNKNOWN );
  91     sal_uInt16 AddIfKnown( const OUString& rPrefix,
  92                 const OUString& rName );
  93
  94     sal_uInt16 GetKeyByName( const OUString& rName ) const;
  95     const OUString& GetNameByKey( sal_uInt16 nKey ) const;
  96
  97     sal_uInt16 GetKeyByPrefix( const OUString& rPrefix ) const;
  98     const OUString& GetPrefixByKey( sal_uInt16 nKey ) const;
  99
 100     OUString GetQNameByKey( sal_uInt16 nKey,
 101                            const OUString& rLocalName,
 102                            bool bCache = true) const;
 103
 104     OUString GetAttrNameByKey( sal_uInt16 nKey ) const;
 105
 106     /* This will replace the version with the unused 5th default parameter */
 107     sal_uInt16 GetKeyByAttrName_( const OUString& rAttrName,
 108                              OUString *pPrefix,
 109                              OUString *pLocalName,
 110                              OUString *pNamespace = nullptr,
 111                              bool bCache = true) const;
 112
 113     /* This will replace the version with the unused 3rd default parameter */
 114     sal_uInt16 GetKeyByAttrName_( const OUString& rAttrName,
 115                              OUString *pLocalName) const;
 116
 117     sal_uInt16 GetFirstKey() const;
 118     sal_uInt16 GetNextKey( sal_uInt16 nOldKey ) const;
 119
 120     /* Give access to all namespace definitions, including multiple entries
 121        for the same key (needed for saving sheets separately in Calc).
 122        This might be replaced by a better interface later. */
 123     const NameSpaceHash& GetAllEntries() const { return aNameHash; }
 124
 125     static bool NormalizeOasisURN( OUString& rName );
 126     static bool NormalizeW3URI( OUString& rName );
 127     static bool NormalizeURI( OUString& rName );
 128
 129 /* deprecated */ void AddAtIndex( sal_uInt16 nIdx, const OUString& rPrefix,
 130                      const OUString& rName, sal_uInt16 nKey );
 131 /* deprecated */ static sal_uInt16 GetIndexByKey( sal_uInt16 nKey );
 132 /* deprecated */ sal_uInt16 GetIndexByPrefix( const OUString& rPrefix ) const;
 133 /* deprecated */ sal_uInt16 GetFirstIndex() const;
 134 /* deprecated */ sal_uInt16 GetNextIndex( sal_uInt16 nOldIdx ) const;
 135 /* deprecated */ const OUString& GetPrefixByIndex( sal_uInt16 nIdx ) const;
 136 /* deprecated */ const OUString& GetNameByIndex( sal_uInt16 nIdx ) const;
 137 /* deprecated */ OUString GetAttrNameByIndex( sal_uInt16 nIdx ) const;
 138 /* deprecated */ OUString GetQNameByIndex( sal_uInt16 nIdx,
 139                             const OUString& rLocalName ) const;
 140 /* deprecated */ sal_uInt16 GetKeyByAttrName( const OUString& rAttrName,
 141                              OUString *pPrefix,
 142                              OUString *pLocalName,
 143                              OUString *pNamespace ) const;
 144 /* deprecated */ sal_uInt16 GetKeyByAttrName( const OUString& rAttrName,
 145                              OUString *pLocalName = nullptr ) const;
 146 };
 147
 148 #endif // INCLUDED_XMLOFF_NMSPMAP_HXX
 149
 150 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */