editeng/inc/ContentNode.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 "editattr.hxx"
  23 #include "edtspell.hxx"
  24 #include <editeng/svxfont.hxx>
  25 #include <svl/itemset.hxx>
  26 #include <svl/style.hxx>
  27 #include <svl/itempool.hxx>
  28 #include <svl/languageoptions.hxx>
  29 #include <tools/lineend.hxx>
  30
  31 #include <memory>
  32 #include <string_view>
  33 #include <vector>
  34
  35 class SvxTabStop;
  36
  37 class ContentAttribs
  38 {
  39 private:
  40     SfxStyleSheet* mpStyle = nullptr;
  41     SfxItemSet maAttribSet;
  42
  43 public:
  44     ContentAttribs(SfxItemPool& rItemPool);
  45
  46     void dumpAsXml(xmlTextWriterPtr pWriter) const;
  47
  48     SvxTabStop FindTabStop(sal_Int32 nCurPos, sal_uInt16 nDefTab);
  49     SfxItemSet& GetItems() { return maAttribSet; }
  50     const SfxItemSet& GetItems() const { return maAttribSet; }
  51     const SfxStyleSheet* GetStyleSheet() const { return mpStyle; }
  52     SfxStyleSheet* GetStyleSheet() { return mpStyle; }
  53     void SetStyleSheet(SfxStyleSheet* pS);
  54
  55     const SfxPoolItem& GetItem(sal_uInt16 nWhich) const;
  56     template <class T> const T& GetItem(TypedWhichId<T> nWhich) const
  57     {
  58         return static_cast<const T&>(GetItem(sal_uInt16(nWhich)));
  59     }
  60     bool HasItem(sal_uInt16 nWhich) const;
  61 };
  62
  63 class CharAttribList
  64 {
  65 public:
  66     typedef std::vector<std::unique_ptr<EditCharAttrib>> AttribsType;
  67
  68 private:
  69     AttribsType maAttribs;
  70     SvxFont maDefFont; // faster than ever from the pool!
  71     bool mbHasEmptyAttribs = false;
  72
  73 public:
  74     void dumpAsXml(xmlTextWriterPtr pWriter) const;
  75
  76     void DeleteEmptyAttribs();
  77
  78     const EditCharAttrib* FindAttrib(sal_uInt16 nWhich, sal_Int32 nPos) const;
  79     EditCharAttrib* FindAttrib(sal_uInt16 nWhich, sal_Int32 nPos);
  80     EditCharAttrib* FindAttribRightOpen(sal_uInt16 nWhich, sal_Int32 nPos);
  81     const EditCharAttrib* FindNextAttrib(sal_uInt16 nWhich, sal_Int32 nFromPos) const;
  82     EditCharAttrib* FindEmptyAttrib(sal_uInt16 nWhich, sal_Int32 nPos);
  83     const EditCharAttrib* FindFeature(sal_Int32 nPos) const;
  84
  85     void ResortAttribs();
  86     void OptimizeRanges();
  87
  88     sal_Int32 Count() const;
  89
  90     void InsertAttrib(EditCharAttrib* pAttrib);
  91
  92     SvxFont& GetDefFont() { return maDefFont; }
  93
  94     bool HasEmptyAttribs() const { return mbHasEmptyAttribs; }
  95     void SetHasEmptyAttribs(bool b);
  96     bool HasBoundingAttrib(sal_Int32 nBound) const;
  97     bool HasAttrib(sal_Int32 nStartPos, sal_Int32 nEndPos) const;
  98
  99     AttribsType& GetAttribs() { return maAttribs; }
 100     const AttribsType& GetAttribs() const { return maAttribs; }
 101
 102     void Remove(const EditCharAttrib* p);
 103     void Remove(sal_Int32 nPos);
 104
 105 #if OSL_DEBUG_LEVEL > 0 && !defined NDEBUG
 106     static void DbgCheckAttribs(CharAttribList const& rAttribs);
 107 #endif
 108 };
 109
 110 class ContentNode
 111 {
 112 private:
 113     OUString maString;
 114     ContentAttribs maContentAttribs;
 115     CharAttribList maCharAttribList;
 116     std::unique_ptr<WrongList> mpWrongList;
 117
 118     void UnExpandPosition(sal_Int32& rStartPos, bool bBiasStart);
 119
 120 public:
 121     ContentNode(SfxItemPool& rItemPool);
 122     ContentNode(const OUString& rStr, const ContentAttribs& rContentAttribs);
 123
 124     ContentNode(const ContentNode&) = delete;
 125     ContentNode& operator=(const ContentNode&) = delete;
 126
 127     void dumpAsXml(xmlTextWriterPtr pWriter) const;
 128
 129     ContentAttribs& GetContentAttribs() { return maContentAttribs; }
 130     const ContentAttribs& GetContentAttribs() const { return maContentAttribs; }
 131     CharAttribList& GetCharAttribs() { return maCharAttribList; }
 132     const CharAttribList& GetCharAttribs() const { return maCharAttribList; }
 133
 134     void ExpandAttribs(sal_Int32 nIndex, sal_Int32 nNewChars);
 135     void CollapseAttribs(sal_Int32 nIndex, sal_Int32 nDelChars);
 136     void AppendAttribs(ContentNode* pNextNode);
 137     void CopyAndCutAttribs(ContentNode* pPrevNode, SfxItemPool& rPool, bool bKeepEndingAttribs);
 138
 139     void SetStyleSheet(SfxStyleSheet* pS, bool bRecalcFont = true);
 140     void SetStyleSheet(SfxStyleSheet* pS, const SvxFont& rFontFromStyle);
 141     SfxStyleSheet* GetStyleSheet() { return maContentAttribs.GetStyleSheet(); }
 142
 143     void CreateDefFont();
 144
 145     void EnsureWrongList();
 146     WrongList* GetWrongList();
 147     const WrongList* GetWrongList() const;
 148     void SetWrongList(WrongList* p);
 149
 150     void CreateWrongList();
 151     void DestroyWrongList();
 152
 153     bool IsFeature(sal_Int32 nPos) const;
 154
 155     sal_Int32 Len() const;
 156     const OUString& GetString() const { return maString; }
 157
 158     /// return length including expanded fields
 159     sal_Int32 GetExpandedLen() const;
 160     /// return content including expanded fields
 161     OUString GetExpandedText(sal_Int32 nStartPos = 0, sal_Int32 nEndPos = -1) const;
 162     /// re-write offsets in the expanded text to string offsets
 163     void UnExpandPositions(sal_Int32& rStartPos, sal_Int32& rEndPos);
 164
 165     void SetChar(sal_Int32 nPos, sal_Unicode c);
 166     void Insert(const OUString& rStr, sal_Int32 nPos);
 167     void Append(std::u16string_view rStr);
 168     void Erase(sal_Int32 nPos);
 169     void Erase(sal_Int32 nPos, sal_Int32 nCount);
 170     OUString Copy(sal_Int32 nPos) const;
 171     OUString Copy(sal_Int32 nPos, sal_Int32 nCount) const;
 172     sal_Unicode GetChar(sal_Int32 nPos) const;
 173
 174     void checkAndDeleteEmptyAttribs() const;
 175 };
 176
 177 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */