sw/inc/authfld.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_INC_AUTHFLD_HXX
  20 #define INCLUDED_SW_INC_AUTHFLD_HXX
  21
  22 #include <sal/config.h>
  23
  24 #include "swdllapi.h"
  25 #include "fldbas.hxx"
  26 #include "toxe.hxx"
  27 #include <rtl/ref.hxx>
  28 #include <sal/log.hxx>
  29 #include <salhelper/simplereferenceobject.hxx>
  30
  31 #include <memory>
  32 #include <vector>
  33
  34 class SwTOXInternational;
  35 class SwTextAttr;
  36 class SwForm;
  37
  38 class SwAuthEntry final : public salhelper::SimpleReferenceObject
  39 {
  40 friend class SwAuthorityFieldType;
  41     OUString        m_aAuthFields[AUTH_FIELD_END];
  42 public:
  43     SwAuthEntry() = default;
  44     SwAuthEntry( const SwAuthEntry& rCopy );
  45     bool            operator==(const SwAuthEntry& rComp) const;
  46
  47     inline OUString const & GetAuthorField(ToxAuthorityField ePos) const;
  48     inline void             SetAuthorField(ToxAuthorityField ePos,
  49                                             const OUString& rField);
  50     void dumpAsXml(xmlTextWriterPtr pWriter) const;
  51 };
  52
  53 struct SwTOXSortKey
  54 {
  55     ToxAuthorityField   eField;
  56     bool                bSortAscending;
  57     SwTOXSortKey() :
  58         eField(AUTH_FIELD_END),
  59         bSortAscending(true){}
  60 };
  61
  62 typedef std::vector<SwTOXSortKey> SortKeyArr;
  63 typedef std::vector<rtl::Reference<SwAuthEntry>> SwAuthDataArr;
  64
  65 class SW_DLLPUBLIC SwAuthorityFieldType final : public SwFieldType
  66 {
  67     SwDoc*                  m_pDoc;
  68     SwAuthDataArr           m_DataArr;
  69     std::vector<SwAuthEntry*> m_SequArr;
  70     std::vector<SwAuthEntry*> m_SequArrRLHidden; ///< hidden redlines
  71     SortKeyArr              m_SortKeyArr;
  72     sal_Unicode             m_cPrefix;
  73     sal_Unicode             m_cSuffix;
  74     bool                    m_bIsSequence :1;
  75     bool                    m_bSortByDocument :1;
  76     LanguageType            m_eLanguage;
  77     OUString                m_sSortAlgorithm;
  78
  79     virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
  80
  81 public:
  82     SwAuthorityFieldType(SwDoc* pDoc);
  83     virtual ~SwAuthorityFieldType() override;
  84
  85     virtual std::unique_ptr<SwFieldType> Copy() const override;
  86
  87     virtual void        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhichId ) const override;
  88     virtual void        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhichId ) override;
  89
  90     void                SetDoc(SwDoc* pNewDoc)              { m_pDoc = pNewDoc; }
  91     SwDoc*              GetDoc(){ return m_pDoc; }
  92     void                RemoveField(const SwAuthEntry* nHandle);
  93     SwAuthEntry*        AddField(std::u16string_view rFieldContents);
  94     void                DelSequenceArray()
  95                         {
  96                             m_SequArr.clear();
  97                             m_SequArrRLHidden.clear();
  98                         }
  99
 100     void                GetAllEntryIdentifiers( std::vector<OUString>& rToFill ) const;
 101     SwAuthEntry*        GetEntryByIdentifier(std::u16string_view rIdentifier) const;
 102
 103     bool                ChangeEntryContent(const SwAuthEntry* pNewEntry);
 104     // import interface
 105     SwAuthEntry*        AppendField(const SwAuthEntry& rInsert);
 106
 107     sal_uInt16          GetSequencePos(const SwAuthEntry* pAuthEntry, SwRootFrame const* pLayout);
 108     std::unique_ptr<SwTOXInternational> CreateTOXInternational() const;
 109
 110     bool                IsSequence() const      {return m_bIsSequence;}
 111     void                SetSequence(bool bSet)
 112                             {
 113                                 DelSequenceArray();
 114                                 m_bIsSequence = bSet;
 115                             }
 116
 117     void                SetPreSuffix( sal_Unicode cPre, sal_Unicode cSuf)
 118                             {
 119                                 m_cPrefix = cPre;
 120                                 m_cSuffix = cSuf;
 121                             }
 122     sal_Unicode         GetPrefix() const { return m_cPrefix;}
 123     sal_Unicode         GetSuffix() const { return m_cSuffix;}
 124
 125     bool                IsSortByDocument() const {return m_bSortByDocument;}
 126     void                SetSortByDocument(bool bSet)
 127                             {
 128                                 DelSequenceArray();
 129                                 m_bSortByDocument = bSet;
 130                             }
 131
 132     sal_uInt16          GetSortKeyCount() const ;
 133     const SwTOXSortKey* GetSortKey(sal_uInt16 nIdx) const ;
 134     void                SetSortKeys(sal_uInt16 nKeyCount, SwTOXSortKey const nKeys[]);
 135
 136     //initui.cxx
 137     static OUString const & GetAuthFieldName(ToxAuthorityField eType);
 138     static OUString const & GetAuthTypeName(ToxAuthorityType eType);
 139
 140     LanguageType    GetLanguage() const {return m_eLanguage;}
 141     void            SetLanguage(LanguageType nLang)  {m_eLanguage = nLang;}
 142
 143     const OUString& GetSortAlgorithm() const {return m_sSortAlgorithm;}
 144     void            SetSortAlgorithm(const OUString& rSet) {m_sSortAlgorithm = rSet;}
 145     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
 146
 147 };
 148
 149 /** Represents an inserted bibliography entry, created using Insert -> Table of Contents and Index
 150     -> Bibliography Entry.
 151
 152     invariant for SwAuthorityField is that it is always registered at its
 153     SwAuthorityFieldType via AddField()/RemoveField() & therefore has m_nHandle
 154     set - but it's possible that multiple SwAuthorityField have the same
 155     m_nHandle & so the number of instances is an upper bound on
 156     SwAuthorityField::m_DataArr.size() - it's not clear to me if more than one
 157     one of the instances with the same m_nHandle is actually in the document,
 158     they're all cloned via CopyField()...
 159  */
 160 class SW_DLLPUBLIC SwAuthorityField final : public SwField
 161 {
 162     rtl::Reference<SwAuthEntry>  m_xAuthEntry;
 163     mutable sal_IntPtr  m_nTempSequencePos;
 164     mutable sal_IntPtr  m_nTempSequencePosRLHidden; ///< hidden redlines
 165
 166     virtual OUString    ExpandImpl(SwRootFrame const* pLayout) const override;
 167     virtual std::unique_ptr<SwField> Copy() const override;
 168
 169 public:
 170     enum TargetType : sal_uInt16
 171     {
 172         UseDisplayURL           = 0,
 173         UseTargetURL            = 1,
 174         None                    = 2,
 175         BibliographyTableRow    = 3,
 176         // BibliographyTablePage   = 4, // TODO: implement
 177     };
 178
 179
 180     /// For internal use only, in general continue using ExpandField() instead.
 181     OUString ConditionalExpandAuthIdentifier(SwRootFrame const* pLayout) const;
 182
 183     //To handle Citation
 184     OUString ExpandCitation(ToxAuthorityField eField, SwRootFrame const* pLayout) const;
 185
 186     SwAuthorityField(SwAuthorityFieldType* pType, std::u16string_view rFieldContents);
 187     SwAuthorityField(SwAuthorityFieldType* pType, SwAuthEntry* pAuthEntry);
 188     virtual ~SwAuthorityField() override;
 189
 190     const OUString &    GetFieldText(ToxAuthorityField eField) const;
 191
 192     virtual void        SetPar1(const OUString& rStr) override;
 193     virtual SwFieldType* ChgTyp( SwFieldType* ) override;
 194
 195     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhichId ) const override;
 196     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhichId ) override;
 197
 198     SwAuthEntry*        GetAuthEntry() const       { return m_xAuthEntry.get(); }
 199
 200     virtual OUString GetDescription() const override;
 201
 202     /**
 203      * Returns the line matching the source's default row in the ToX.
 204      *
 205      * \param   pLayout     layout to be used
 206      * \param   pTOX        bibliography table to take the format of the string from
 207      * \return              entry formatted as the appropriate authority type in the table
 208      */
 209     OUString GetAuthority(const SwRootFrame *pLayout,
 210                           const SwForm *pTOX = nullptr) const;
 211
 212     /**
 213      * Returns which target should be used when the entry
 214      *   (the standalone field, such as '[ASDF]', not in the table) is clicked.
 215      */
 216     TargetType GetTargetType() const;
 217     /**
 218      * Returns absolute target URL in case there is one (GetTargetType() should be checked).
 219      *   If there isn't one, the result is undefined.
 220      */
 221     OUString GetAbsoluteURL() const;
 222
 223     /**
 224      * Returns full URI for the URL, relative if specified
 225      * \param   bRelative   whether the path should be relative (when dealing with local files)
 226      */
 227     OUString GetURI(bool bRelative) const;
 228
 229     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
 230 };
 231
 232 inline OUString const & SwAuthEntry::GetAuthorField(ToxAuthorityField ePos) const
 233 {
 234     SAL_WARN_IF(AUTH_FIELD_END <= ePos, "sw", "wrong index");
 235     return m_aAuthFields[ePos];
 236 }
 237 inline void SwAuthEntry::SetAuthorField(ToxAuthorityField ePos, const OUString& rField)
 238 {
 239     SAL_WARN_IF(AUTH_FIELD_END <= ePos, "sw", "wrong index");
 240     if(AUTH_FIELD_END > ePos)
 241         m_aAuthFields[ePos] = rField;
 242 }
 243
 244 #endif
 245
 246 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */