sw/source/core/inc/txmsrt.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 #ifndef INCLUDED_SW_SOURCE_CORE_INC_TXMSRT_HXX
  20 #define INCLUDED_SW_SOURCE_CORE_INC_TXMSRT_HXX
  21
  22 #include <i18nlangtag/lang.h>
  23 #include <unotools/charclass.hxx>
  24 #include <nodeoffset.hxx>
  25 #include <tox.hxx>
  26
  27 #include <com/sun/star/lang/Locale.hpp>
  28 #include <optional>
  29 #include <utility>
  30
  31 class SwContentNode;
  32 class SwTextNode;
  33 class SwTextTOXMark;
  34 class SwContentIndex;
  35 class SwFormatField;
  36 class SwRootFrame;
  37 class IndexEntrySupplierWrapper;
  38
  39 enum TOXSortType
  40 {
  41     TOX_SORT_INDEX,
  42     TOX_SORT_CUSTOM,
  43     TOX_SORT_CONTENT,
  44     TOX_SORT_PARA,
  45     TOX_SORT_TABLE,
  46     TOX_SORT_AUTHORITY
  47 };
  48
  49 struct SwTOXSource
  50 {
  51     const SwContentNode* pNd;
  52     sal_Int32 nPos;
  53     bool bMainEntry;
  54
  55     SwTOXSource( const SwContentNode* pNode, sal_Int32 n, bool bMain )
  56         : pNd(pNode), nPos(n), bMainEntry(bMain)
  57     {
  58     }
  59 };
  60
  61 struct TextAndReading
  62 {
  63     OUString sText;
  64     OUString sReading;
  65
  66     TextAndReading() {}
  67
  68     TextAndReading(OUString aText, OUString aReading)
  69     : sText(std::move(aText))
  70     , sReading(std::move(aReading))
  71     {}
  72 };
  73
  74 class SwTOXInternational
  75 {
  76     std::unique_ptr<IndexEntrySupplierWrapper> m_pIndexWrapper;
  77     std::optional<CharClass>   m_oCharClass;
  78     LanguageType               m_eLang;
  79     OUString                   m_sSortAlgorithm;
  80     SwTOIOptions               m_nOptions;
  81
  82     void Init();
  83
  84 public:
  85     SwTOXInternational( LanguageType nLang, SwTOIOptions nOptions,
  86                         OUString aSortAlgorithm );
  87     SwTOXInternational( const SwTOXInternational& );
  88     ~SwTOXInternational();
  89
  90     sal_Int32 Compare( const TextAndReading& rTaR1,
  91                        const css::lang::Locale& rLocale1,
  92                        const TextAndReading& rTaR2,
  93                        const css::lang::Locale& rLocale2 ) const;
  94
  95     bool IsEqual( const TextAndReading& rTaR1,
  96                          const css::lang::Locale& rLocale1,
  97                          const TextAndReading& rTaR2,
  98                          const css::lang::Locale& rLocale2 ) const
  99     {
 100         return 0 == Compare( rTaR1, rLocale1, rTaR2, rLocale2 );
 101     }
 102
 103     bool IsLess( const TextAndReading& rTaR1,
 104                         const css::lang::Locale& rLocale1,
 105                         const TextAndReading& rTaR2,
 106                         const css::lang::Locale& rLocale2 ) const
 107     {
 108         return -1 == Compare( rTaR1, rLocale1, rTaR2, rLocale2 );
 109     }
 110
 111     OUString GetIndexKey( const TextAndReading& rTaR,
 112                         const css::lang::Locale& rLcl ) const;
 113
 114     OUString GetFollowingText( bool bMorePages ) const;
 115
 116     OUString ToUpper( const OUString& rStr, sal_Int32 nPos ) const;
 117     bool IsNumeric( const OUString& rStr ) const;
 118 };
 119
 120 /**
 121  * Class for sorting directories
 122  */
 123 struct SwTOXSortTabBase
 124 {
 125     bool operator==(const SwTOXSortTabBase&) const = delete;
 126     bool operator<(const SwTOXSortTabBase&) const = delete;
 127
 128     std::vector<SwTOXSource>       aTOXSources;
 129     css::lang::Locale aLocale;
 130     const SwTextNode* pTOXNd;
 131     const SwTextTOXMark* pTextMark;
 132     const SwTOXInternational* pTOXIntl;
 133     SwNodeOffset nPos;
 134     sal_Int32 nCntPos;
 135     sal_uInt16 nType;
 136     static SwTOIOptions nOpt;
 137
 138     SwTOXSortTabBase( TOXSortType nType,
 139                       const SwContentNode* pTOXSrc,
 140                       const SwTextTOXMark* pTextMark,
 141                       const SwTOXInternational* pIntl,
 142                       const css::lang::Locale* pLocale = nullptr );
 143     virtual ~SwTOXSortTabBase() {}
 144
 145     sal_uInt16  GetType() const         { return nType; }
 146     static SwTOIOptions  GetOptions()   { return nOpt; }
 147
 148     virtual void    FillText(SwTextNode& rNd, const SwContentIndex& rInsPos,
 149             sal_uInt16 nAuthField, SwRootFrame const* pLayout) const;
 150     virtual sal_uInt16  GetLevel()  const = 0;
 151     virtual bool    equivalent( const SwTOXSortTabBase& );
 152     virtual bool    sort_lt( const SwTOXSortTabBase& );
 153
 154     virtual std::pair<OUString, bool> GetURL(SwRootFrame const*const pLayout) const;
 155
 156     virtual bool IsFullPara() const;
 157
 158     // must be called
 159     inline void InitText(SwRootFrame const*const pLayout);
 160     inline TextAndReading const & GetText() const;
 161     inline const css::lang::Locale& GetLocale() const;
 162
 163 private:
 164     bool m_bValidText;
 165     TextAndReading m_aSort;
 166
 167     virtual TextAndReading GetText_Impl(SwRootFrame const* pLayout) const = 0;
 168 };
 169
 170 inline void SwTOXSortTabBase::InitText(SwRootFrame const*const pLayout)
 171 {
 172         // 'this' is 'SwTOXSortTabBase const*', so the virtual
 173         // mechanism will call the derived class' GetText_Impl
 174     assert(!m_bValidText);
 175     m_aSort = GetText_Impl(pLayout);
 176     m_bValidText = true;
 177 }
 178
 179 inline TextAndReading const & SwTOXSortTabBase::GetText() const
 180 {
 181     assert(m_bValidText);
 182     return m_aSort;
 183 }
 184
 185 inline const css::lang::Locale& SwTOXSortTabBase::GetLocale() const
 186 {
 187     return aLocale;
 188 }
 189
 190 /**
 191  * For sorting by text
 192  */
 193 struct SwTOXIndex final : public SwTOXSortTabBase
 194 {
 195     SwTOXIndex( const SwTextNode&, const SwTextTOXMark*, SwTOIOptions nOptions, sal_uInt8 nKeyLevel,
 196                 const SwTOXInternational& rIntl,
 197                 const css::lang::Locale& rLocale );
 198
 199     virtual void    FillText(SwTextNode& rNd, const SwContentIndex& rInsPos,
 200             sal_uInt16 nAuthField, SwRootFrame const* pLayout) const override;
 201     virtual sal_uInt16  GetLevel() const override;
 202     virtual bool    equivalent( const SwTOXSortTabBase& ) override;
 203     virtual bool    sort_lt( const SwTOXSortTabBase& ) override;
 204
 205 private:
 206     virtual TextAndReading GetText_Impl(SwRootFrame const* pLayout) const override;
 207
 208     sal_uInt8   nKeyLevel;
 209 };
 210
 211 struct SwTOXCustom final : public SwTOXSortTabBase
 212 {
 213     SwTOXCustom( TextAndReading aKey, sal_uInt16 nLevel,
 214                  const SwTOXInternational& rIntl,
 215                  const css::lang::Locale& rLocale );
 216
 217     virtual sal_uInt16 GetLevel() const override;
 218     virtual bool   equivalent( const SwTOXSortTabBase& ) override;
 219     virtual bool   sort_lt( const SwTOXSortTabBase& ) override;
 220
 221 private:
 222     virtual TextAndReading GetText_Impl(SwRootFrame const* pLayout) const override;
 223
 224     TextAndReading m_aKey;
 225     sal_uInt16  nLev;
 226 };
 227
 228 /**
 229  * For sorting by position
 230  */
 231 struct SwTOXContent final : public SwTOXSortTabBase
 232 {
 233     SwTOXContent( const SwTextNode&, const SwTextTOXMark*,
 234                 const SwTOXInternational& rIntl );
 235
 236     virtual void    FillText(SwTextNode& rNd, const SwContentIndex& rInsPos,
 237             sal_uInt16 nAuthField, SwRootFrame const* pLayout) const override;
 238     virtual sal_uInt16  GetLevel() const override;
 239 private:
 240     virtual TextAndReading GetText_Impl(SwRootFrame const* pLayout) const override;
 241
 242 };
 243
 244 struct SwTOXPara final : public SwTOXSortTabBase
 245 {
 246     SwTOXPara(SwContentNode&, SwTOXElement,
 247               sal_uInt16 nLevel = FORM_ALPHA_DELIMITER,
 248               OUString sSeqName = OUString());
 249
 250     void    SetStartIndex(sal_Int32 nSet)    { nStartIndex = nSet; }
 251     void    SetEndIndex(sal_Int32 nSet)      { nEndIndex = nSet; }
 252
 253     virtual void    FillText(SwTextNode& rNd, const SwContentIndex& rInsPos,
 254             sal_uInt16 nAuthField, SwRootFrame const* pLayout) const override;
 255     virtual sal_uInt16  GetLevel() const override;
 256
 257     virtual std::pair<OUString, bool> GetURL(SwRootFrame const*const pLayout) const override;
 258     virtual bool IsFullPara() const override;
 259 private:
 260     virtual TextAndReading GetText_Impl(SwRootFrame const* pLayout) const override;
 261
 262     SwTOXElement eType;
 263     sal_uInt16 m_nLevel;
 264     sal_Int32 nStartIndex;
 265     sal_Int32 nEndIndex;
 266     OUString m_sSequenceName;
 267 };
 268
 269 struct SwTOXTable final : public SwTOXSortTabBase
 270 {
 271     SwTOXTable( const SwContentNode& rNd );
 272
 273     void    SetLevel(sal_uInt16 nSet){nLevel = nSet;}
 274
 275     virtual sal_uInt16  GetLevel() const override;
 276
 277     virtual std::pair<OUString, bool> GetURL(SwRootFrame const*const pLayout) const override;
 278
 279 private:
 280     virtual TextAndReading GetText_Impl(SwRootFrame const* pLayout) const override;
 281
 282     sal_uInt16 nLevel;
 283 };
 284
 285 /// Represents one row in the bibliography table.
 286 struct SwTOXAuthority final : public SwTOXSortTabBase
 287 {
 288 private:
 289     SwFormatField& m_rField;
 290     virtual void    FillText(SwTextNode& rNd, const SwContentIndex& rInsPos,
 291             sal_uInt16 nAuthField, SwRootFrame const* pLayout) const override;
 292     virtual TextAndReading GetText_Impl(SwRootFrame const* pLayout) const override;
 293
 294 public:
 295     SwTOXAuthority( const SwContentNode& rNd, SwFormatField& rField, const SwTOXInternational& rIntl );
 296
 297     SwFormatField& GetFieldFormat() {return m_rField;}
 298
 299     virtual bool    equivalent( const SwTOXSortTabBase& ) override;
 300     virtual bool    sort_lt( const SwTOXSortTabBase& ) override;
 301     virtual sal_uInt16  GetLevel() const override;
 302     OUString GetText(sal_uInt16 nAuthField, const SwRootFrame* pLayout) const;
 303
 304     /// Gets the URL of the underlying SwAuthEntry, ignoring its page number.
 305     static OUString GetSourceURL(const OUString& rText);
 306 };
 307
 308 #endif // INCLUDED_SW_SOURCE_CORE_INC_TXMSRT_HXX
 309
 310 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */