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 "swdllapi.h"
  23 #include <fldbas.hxx>
  24 #include <toxe.hxx>
  25 #include <sal/log.hxx>
  26
  27 #include <memory>
  28 #include <vector>
  29
  30 class SwAuthEntry
  31 {
  32     OUString        aAuthFields[AUTH_FIELD_END];
  33     sal_uInt16      nRefCount;
  34 public:
  35     SwAuthEntry() : nRefCount(0){}
  36     SwAuthEntry( const SwAuthEntry& rCopy );
  37     bool            operator==(const SwAuthEntry& rComp);
  38
  39     inline OUString const & GetAuthorField(ToxAuthorityField ePos) const;
  40     inline void             SetAuthorField(ToxAuthorityField ePos,
  41                                             const OUString& rField);
  42
  43     void            AddRef()                { ++nRefCount; }
  44     void            RemoveRef()             { --nRefCount; }
  45     sal_uInt16          GetRefCount()           { return nRefCount; }
  46 };
  47
  48 struct SwTOXSortKey
  49 {
  50     ToxAuthorityField   eField;
  51     bool                bSortAscending;
  52     SwTOXSortKey() :
  53         eField(AUTH_FIELD_END),
  54         bSortAscending(true){}
  55 };
  56
  57 class SwAuthorityField;
  58 typedef std::vector<SwTOXSortKey> SortKeyArr;
  59 typedef std::vector<std::unique_ptr<SwAuthEntry>> SwAuthDataArr;
  60
  61 class SW_DLLPUBLIC SwAuthorityFieldType : public SwFieldType
  62 {
  63     SwDoc*                  m_pDoc;
  64     SwAuthDataArr           m_DataArr;
  65     std::vector<sal_IntPtr> m_SequArr;
  66     SortKeyArr              m_SortKeyArr;
  67     sal_Unicode             m_cPrefix;
  68     sal_Unicode             m_cSuffix;
  69     bool                m_bIsSequence :1;
  70     bool                m_bSortByDocument :1;
  71     LanguageType            m_eLanguage;
  72     OUString                m_sSortAlgorithm;
  73
  74 protected:
  75 virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew ) override;
  76
  77 public:
  78     SwAuthorityFieldType(SwDoc* pDoc);
  79     virtual ~SwAuthorityFieldType() override;
  80
  81     virtual SwFieldType* Copy()    const override;
  82
  83     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhichId ) const override;
  84     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhichId ) override;
  85
  86     void         SetDoc(SwDoc* pNewDoc)              { m_pDoc = pNewDoc; }
  87     SwDoc*              GetDoc(){ return m_pDoc; }
  88     void                RemoveField(sal_IntPtr nHandle);
  89     sal_IntPtr          AddField(const OUString& rFieldContents);
  90     bool            AddField(sal_IntPtr nHandle);
  91     void                DelSequenceArray()
  92                         {
  93                             m_SequArr.clear();
  94                         }
  95
  96     const SwAuthEntry*  GetEntryByHandle(sal_IntPtr nHandle) const;
  97
  98     void                GetAllEntryIdentifiers( std::vector<OUString>& rToFill ) const;
  99     const SwAuthEntry*  GetEntryByIdentifier(const OUString& rIdentifier) const;
 100
 101     bool                ChangeEntryContent(const SwAuthEntry* pNewEntry);
 102     // import interface
 103     sal_uInt16          AppendField(const SwAuthEntry& rInsert);
 104     sal_IntPtr          GetHandle(sal_uInt16 nPos);
 105
 106     sal_uInt16          GetSequencePos(sal_IntPtr nHandle);
 107
 108     bool            IsSequence() const      {return m_bIsSequence;}
 109     void                SetSequence(bool bSet)
 110                             {
 111                                 DelSequenceArray();
 112                                 m_bIsSequence = bSet;
 113                             }
 114
 115     void                SetPreSuffix( sal_Unicode cPre, sal_Unicode cSuf)
 116                             {
 117                                 m_cPrefix = cPre;
 118                                 m_cSuffix = cSuf;
 119                             }
 120     sal_Unicode         GetPrefix() const { return m_cPrefix;}
 121     sal_Unicode         GetSuffix() const { return m_cSuffix;}
 122
 123     bool            IsSortByDocument() const {return m_bSortByDocument;}
 124     void                SetSortByDocument(bool bSet)
 125                             {
 126                                 DelSequenceArray();
 127                                 m_bSortByDocument = bSet;
 128                             }
 129
 130     sal_uInt16          GetSortKeyCount() const ;
 131     const SwTOXSortKey* GetSortKey(sal_uInt16 nIdx) const ;
 132     void                SetSortKeys(sal_uInt16 nKeyCount, SwTOXSortKey nKeys[]);
 133
 134     //initui.cxx
 135     static OUString     GetAuthFieldName(ToxAuthorityField eType);
 136     static OUString     GetAuthTypeName(ToxAuthorityType eType);
 137
 138     LanguageType    GetLanguage() const {return m_eLanguage;}
 139     void            SetLanguage(LanguageType nLang)  {m_eLanguage = nLang;}
 140
 141     const OUString& GetSortAlgorithm() const {return m_sSortAlgorithm;}
 142     void            SetSortAlgorithm(const OUString& rSet) {m_sSortAlgorithm = rSet;}
 143
 144 };
 145
 146 class SwAuthorityField : public SwField
 147 {
 148     sal_IntPtr          m_nHandle;
 149     mutable sal_IntPtr  m_nTempSequencePos;
 150
 151     virtual OUString    Expand() const override;
 152     virtual SwField*    Copy() const override;
 153
 154 public:
 155     /// For internal use only, in general continue using ExpandField() instead.
 156     OUString ConditionalExpandAuthIdentifier() const;
 157
 158     //To handle Citation
 159     SW_DLLPUBLIC OUString ExpandCitation(ToxAuthorityField eField) const;
 160
 161     SwAuthorityField(SwAuthorityFieldType* pType, const OUString& rFieldContents);
 162     SwAuthorityField(SwAuthorityFieldType* pType, sal_IntPtr nHandle);
 163     virtual ~SwAuthorityField() override;
 164
 165     OUString            GetFieldText(ToxAuthorityField eField) const;
 166
 167     virtual void        SetPar1(const OUString& rStr) override;
 168     virtual SwFieldType* ChgTyp( SwFieldType* ) override;
 169
 170     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhichId ) const override;
 171     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhichId ) override;
 172
 173     sal_IntPtr          GetHandle() const       { return m_nHandle; }
 174
 175     virtual OUString GetDescription() const override;
 176 };
 177
 178 inline OUString const & SwAuthEntry::GetAuthorField(ToxAuthorityField ePos) const
 179 {
 180     SAL_WARN_IF(AUTH_FIELD_END <= ePos, "sw", "wrong index");
 181     return aAuthFields[ePos];
 182 }
 183 inline void SwAuthEntry::SetAuthorField(ToxAuthorityField ePos, const OUString& rField)
 184 {
 185     SAL_WARN_IF(AUTH_FIELD_END <= ePos, "sw", "wrong index");
 186     if(AUTH_FIELD_END > ePos)
 187         aAuthFields[ePos] = rField;
 188 }
 189
 190 #endif
 191
 192 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */