1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef SW_TOXTEXTGENERATOR_HXX_
#define SW_TOXTEXTGENERATOR_HXX_
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include "fmtautofmt.hxx"
#include <memory>
#include <optional>
#include <vector>
#include <unordered_map>
class SfxItemSet;
class SwAttrPool;
class SwFormatAutoFormat;
class SwChapterField;
class SwChapterFieldType;
class SwContentFrame;
class SwRootFrame;
class SwContentNode;
class SwDoc;
class SwForm;
struct SwFormToken;
class SwTextAttr;
class SwTextNode;
struct SwTOXSortTabBase;
class ToxTextGeneratorTest;
namespace sw {
class ToxLinkProcessor;
class ToxTabStopTokenHandler;
class ToxWhitespaceStripper;
/** This class generates text for the entries of a table of x.
*
* You can control its behavior by calling @link SetTabstopPolicy() and specifying the desired behavior.
*/
class ToxTextGenerator
{
public:
ToxTextGenerator(const SwForm& toxForm, std::shared_ptr<ToxTabStopTokenHandler> tabStopHandler);
virtual ~ToxTextGenerator();
/** Generate the text for an entry of a table of X (X is, e.g., content).
*
* This method will process the entries in @p entries, starting at @p indexOfEntryToProcess and
* process @p numberOfEntriesToProcess entries.
*/
std::optional<std::pair<SwTextNode *, SvxTabStopItem>>
GenerateText(SwDoc *doc,
std::unordered_map<OUString, int> & rMarkURLs,
const std::vector<std::unique_ptr<SwTOXSortTabBase>>& entries,
sal_uInt16 indexOfEntryToProcess, sal_uInt16 numberOfEntriesToProcess,
SwRootFrame const* pLayout);
private:
const SwForm& mToxForm;
std::shared_ptr<ToxLinkProcessor> mLinkProcessor;
std::shared_ptr<ToxTabStopTokenHandler> mTabStopTokenHandler;
/** A handled text token.
* It contains the information which should be added to the target text node.
*/
struct HandledTextToken {
OUString text;
std::vector<std::unique_ptr<SwFormatAutoFormat>> autoFormats;
std::vector<sal_Int32> startPositions;
std::vector<sal_Int32> endPositions;
};
static void GetAttributesForNode(
HandledTextToken & rResult,
sal_Int32 & rOffset,
SwTextNode const& rNode,
ToxWhitespaceStripper const& rStripper,
SwAttrPool & rPool,
SwRootFrame const*const pLayout);
/** Append text (and selected attributes) to a target node.
*
* Will take the text of @p source, and return the text and the attributes which should be added to the
* target text node. @see CollectAttributesForTox() for the criteria of the attributes which are taken.
*/
static HandledTextToken
HandleTextToken(const SwTOXSortTabBase& source, SwAttrPool& attrPool,
SwRootFrame const*const pLayout);
/** Applies the result of a handled text token to a target node. */
static void
ApplyHandledTextToken(const HandledTextToken& htt, SwTextNode& targetNode);
/** Handle a page number token.
*
* Will return a string of @p numberOfToxSources concatenated '@' signs, separated by commas, and
* finished by a '~'.
* (The '@' sign is the magic character C_NUM_REPL, the '~' sign is the magic character C_END_PAGE_NUM.
*
* @internal
* The count of similar entries, i.e., nodes in aTOXSources of SwTOXSortTabBase gives the PagerNumber
* pattern.
*/
static OUString
ConstructPageNumberPlaceholder(size_t numberOfToxSources);
/** Collect the attributes of a hint that shall be copied over to the TOX.
*
* Some text attributes are used in the TOX entries. This method defines which attributes are used.
*
* @param hint The hint from which the attributes are taken
* @param pool The attribute pool for the new items
*/
static std::shared_ptr<SfxItemSet>
CollectAttributesForTox(const SwTextAttr& hint, SwAttrPool& pool);
/** This method will call GetNumStringOfFirstNode() of the first node in the provided SwTOXSortTabBase.
*
* The parameters @p bUsePrefix and @p nLevel are passed to SwTextNode::GetNumString()
*
* @internal
* The method is only called if several preconditions for @p rBase are true. Check the implementation
* for details.
*/
static OUString
GetNumStringOfFirstNode(const SwTOXSortTabBase& rBase, bool bUsePrefix,
sal_uInt8 nLevel, SwRootFrame const* pLayout, bool bAddSpace = true);
/** Handle a chapter token.
*/
OUString
HandleChapterToken(const SwTOXSortTabBase& rBase, const SwFormToken& aToken,
SwRootFrame const* pLayout) const;
/** Generate the text for a chapter token.
*/
OUString
GenerateTextForChapterToken(const SwFormToken& chapterToken, const SwContentFrame* contentFrame,
const SwContentNode *contentNode, SwRootFrame const* pLayout) const;
/** Obtain a ChapterField to use for the text generation.
* @internal
* This method is overridden in the unittests. Do not override it yourself.
*/
virtual SwChapterField
ObtainChapterField(SwChapterFieldType* chapterFieldType, const SwFormToken* chapterToken,
const SwContentFrame* contentFrame, const SwContentNode *contentNode) const;
friend class ::ToxTextGeneratorTest;
};
}
#endif /* SW_TOXTEXTGENERATOR_HXX_ */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
