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
|
/* -*- 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 INCLUDED_SW_INC_MODELTOVIEWHELPER_HXX
#define INCLUDED_SW_INC_MODELTOVIEWHELPER_HXX
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <o3tl/typed_flags_set.hxx>
#include <vector>
class SwTextNode;
class SwRootFrame;
/** Some helpers for converting model strings to view strings.
A paragraph string does not have its fields expanded, i.e., they are
represented by a special character inside the string with an additional
attribute assigned to it. For some tasks (e.g., SmartTags) it is required
to expand the fields to get the string as it appears in the view. Two
helper functions are provided to convert model positions to view positions
and vice versa.
CH_TXTATR_BREAKWORD -> SwTextNode will have field attributes associated with these
. .
. .
. .
AAAAA BBBBB # CCCCC # DDDDD
| | | |
| | | |
| ---------
| | .
| | .
| | .......... bounds of a hidden text character attribute
------
.
.
.............. a range of text defined in redline region as deleted
0000: pass through gives: AAAAA BBBBB # CCCCC # DDDDD
0001: only expanding fields gives: AAAAA BBBBB foo CCCCC foo DDDDD
0010: only hiding hiddens gives: AAAAA CCCCC # DDDDD
0100: only hiding redlines gives: AAAABB # CCCCC # DDDDD
0011: expanding fields + hiding hiddens gives: AAAAA CCCC foo DDDDD
0101: expanding fields + hiding redlines gives: AAAA B foo CCCCC foo DDDDD
0110: hiding hiddens + hiding redlines gives: AAAACCCC # DDDDD
0111: expanding fields + hiding hiddens + hiding redlines gives: AAAABB foo CCCCC foo DDDDD
*/
enum class ExpandMode
{
PassThrough = 0x0000,
ExpandFields = 0x0001,
ExpandFootnote = 0x0002,
HideInvisible = 0x0004,
HideDeletions = 0x0008,
/// do not expand to content, but replace with zwsp
ReplaceMode = 0x0010,
HideFieldmarkCommands = 0x0020,
};
namespace o3tl
{
template<> struct typed_flags<ExpandMode> : is_typed_flags<ExpandMode, 0x003f> {};
}
class ModelToViewHelper
{
/** For each expanded/hidden portion in the model string, there is an entry in
the conversion map. The first value of the ConversionMapEntry points to
the start position in the model string, the second value points to the
associated start position in the view string. The last entry in the
conversion map denotes the lengths of the model resp. view string.
*/
struct ConversionMapEntry
{
ConversionMapEntry(sal_Int32 nModelPos, sal_Int32 nViewPos, bool bVisible)
: m_nModelPos(nModelPos)
, m_nViewPos(nViewPos)
, m_bVisible(bVisible)
{
}
sal_Int32 m_nModelPos;
sal_Int32 m_nViewPos;
bool m_bVisible;
};
typedef std::vector< ConversionMapEntry > ConversionMap;
ConversionMap m_aMap;
/// store positions of fields and footnotes for grammar checkers
std::vector<sal_Int32> m_FieldPositions;
std::vector<sal_Int32> m_FootnotePositions;
OUString m_aRetText;
public:
/** This struct defines a position in the model string.
The 'main' position is given by mnPos. If there's a field located at
this position, mbIsField is set and mnSubPos denotes the position inside
that field.
*/
struct ModelPosition
{
sal_Int32 mnPos;
sal_Int32 mnSubPos;
bool mbIsField;
ModelPosition() : mnPos(0), mnSubPos(0), mbIsField(false) {}
};
ModelToViewHelper(const SwTextNode &rNode, SwRootFrame const* pLayout,
// defaults are appropriate for spell/grammar checking
ExpandMode eMode = ExpandMode::ExpandFields | ExpandMode::ExpandFootnote | ExpandMode::HideFieldmarkCommands | ExpandMode::ReplaceMode);
ModelToViewHelper() //pass through filter, view == model
{
}
/** Converts a model position into a view position
@param nPos
nPos denotes a position in the model string which should be
converted. Note that converting model positions inside fields is
not supported, therefore nPos is not of type ModelPosition.
@return
the position of nPos in the view string. In case the conversion
could not be performed (e.g., because there is not ConversionMap or
nPos is behind the last entry in the conversion map) nPos will
be returned.
*/
sal_Int32 ConvertToViewPosition( sal_Int32 nModelPos ) const;
/** Converts a view position into a model position
@param nPos
nPos denotes a position in the view string which should be
converted.
@return
the position of nPos in the model string. In case the conversion
could not be performed (e.g., because there is not ConversionMap or
nPos is behind the last entry in the conversion map) a model
model position with mnPos = nPos and mnIsField = false will be
returned.
*/
ModelPosition ConvertToModelPosition( sal_Int32 nViewPos ) const;
const OUString& getViewText() const { return m_aRetText; }
std::vector<sal_Int32> const& getFieldPositions() const { return m_FieldPositions; }
std::vector<sal_Int32> const& getFootnotePositions() const { return m_FootnotePositions;}
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
