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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/* -*- 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_OOX_HELPER_ATTRIBUTELIST_HXX
#define INCLUDED_OOX_HELPER_ATTRIBUTELIST_HXX
#include <sal/config.h>
#include <string_view>
#include <vector>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/util/DateTime.hpp>
#include <oox/dllapi.h>
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <oox/drawingml/color.hxx>
namespace com::sun::star {
namespace xml::sax { class XFastAttributeList; }
}
namespace sax_fastparser {
class FastAttributeList;
};
namespace oox {
/* Get the color tokens from their string representatives. */
sal_Int32 getHighlightColorTokenFromString(std::u16string_view sColorName);
/** Static helpers for conversion of strings to attribute values of various
different data types.
*/
class OOX_DLLPUBLIC AttributeConversion
{
public:
/** Returns the XML token identifier from the passed string. */
static sal_Int32 decodeToken( std::u16string_view rValue );
/** Returns the decoded string value. All characters in the format
'_xHHHH_' (H being a hexadecimal digit), will be decoded. */
static OUString decodeXString( const OUString& rValue );
/** Returns the 32-bit signed integer value from the passed string (decimal). */
static sal_Int32 decodeInteger( std::u16string_view rValue );
/** Returns the 32-bit unsigned integer value from the passed string (decimal). */
static sal_uInt32 decodeUnsigned( std::u16string_view rValue );
/** Returns the 64-bit signed integer value from the passed string (decimal). */
static sal_Int64 decodeHyper( std::u16string_view rValue );
/** Returns the 32-bit signed integer value from the passed string (hexadecimal). */
static sal_Int32 decodeIntegerHex( std::u16string_view rValue );
};
/** Provides access to attribute values of an element.
Wraps a com.sun.star.xml.sax.XFastAttributeList object. Provides
convenience functions that convert the string value of an attribute to
various other data types.
*/
class OOX_DLLPUBLIC AttributeList
{
public:
explicit AttributeList(
const css::uno::Reference< css::xml::sax::XFastAttributeList >& rxAttribs );
/** Returns the wrapped com.sun.star.xml.sax.XFastAttributeList object. */
const css::uno::Reference< css::xml::sax::XFastAttributeList >&
getFastAttributeList() const { return mxAttribs; }
/** Returns true, if the specified attribute is present. */
bool hasAttribute( sal_Int32 nAttrToken ) const;
// optional return values -------------------------------------------------
/** Returns the token identifier of the value of the specified attribute. */
std::optional< sal_Int32 > getToken( sal_Int32 nAttrToken ) const;
/** Returns the Color object of highlight of the text. */
oox::drawingml::Color getHighlightColor(sal_Int32 nAttrToken) const;
/** Returns the string value of the specified attribute. */
std::optional< OUString > getString( sal_Int32 nAttrToken ) const;
/** Returns the string value of the specified attribute, returns an empty string if attribute not present. */
OUString getStringDefaulted( sal_Int32 nAttrToken ) const;
/** Returns the string value of the specified attribute. All characters in
the format '_xHHHH_' (H being a hexadecimal digit), will be decoded. */
std::optional< OUString > getXString( sal_Int32 nAttrToken ) const;
/** Returns the double value of the specified attribute. */
std::optional< double > getDouble( sal_Int32 nAttrToken ) const;
/** Returns the 32-bit signed integer value of the specified attribute (decimal). */
std::optional< sal_Int32 > getInteger( sal_Int32 nAttrToken ) const;
/** Returns the 32-bit unsigned integer value of the specified attribute (decimal). */
std::optional< sal_uInt32 > getUnsigned( sal_Int32 nAttrToken ) const;
/** Returns the 64-bit signed integer value of the specified attribute (decimal). */
std::optional< sal_Int64 > getHyper( sal_Int32 nAttrToken ) const;
/** Returns the 32-bit signed integer value of the specified attribute (hexadecimal). */
std::optional< sal_Int32 > getIntegerHex( sal_Int32 nAttrToken ) const;
/** Returns the boolean value of the specified attribute. */
std::optional< bool > getBool( sal_Int32 nAttrToken ) const;
/** Returns the date/time value of the specified attribute. */
std::optional< css::util::DateTime > getDateTime( sal_Int32 nAttrToken ) const;
// defaulted return values ------------------------------------------------
/** Returns the token identifier of the value of the specified attribute,
or the passed default identifier if the attribute is missing. */
sal_Int32 getToken( sal_Int32 nAttrToken, sal_Int32 nDefault ) const;
/** Returns the string value of the specified attribute, or the passed
default string if the attribute is missing. */
OUString getString( sal_Int32 nAttrToken, const OUString& rDefault ) const;
/** Returns the decoded string value of the specified attribute, or the
passed default string if the attribute is missing. */
OUString getXString( sal_Int32 nAttrToken, const OUString& rDefault ) const;
std::string_view getView( sal_Int32 nAttrToken ) const;
/** Returns the double value of the specified attribute, or the passed
default value if the attribute is missing or not convertible to a double. */
double getDouble( sal_Int32 nAttrToken, double fDefault ) const;
/** Returns the 32-bit signed integer value of the specified attribute, or the
passed default value if the attribute is missing or not convertible to integer. */
sal_Int32 getInteger( sal_Int32 nAttrToken, sal_Int32 nDefault ) const;
/** Returns the 32-bit unsigned integer value of the specified attribute, or the
passed default value if the attribute is missing or not convertible to unsigned. */
sal_uInt32 getUnsigned( sal_Int32 nAttrToken, sal_uInt32 nDefault ) const;
/** Returns the 64-bit signed integer value of the specified attribute, or the
passed default value if the attribute is missing or not convertible to integer. */
sal_Int64 getHyper( sal_Int32 nAttrToken, sal_Int64 nDefault ) const;
/** Returns the 32-bit signed integer value of the specified attribute (hexadecimal),
or the passed default value if the attribute is missing or not convertible. */
sal_Int32 getIntegerHex( sal_Int32 nAttrToken, sal_Int32 nDefault ) const;
sal_uInt32 getUnsignedHex( sal_Int32 nAttrToken, sal_uInt32 nDefault ) const;
/** Returns the boolean value of the specified attribute, or the passed
default value if the attribute is missing or not convertible to bool. */
bool getBool( sal_Int32 nAttrToken, bool bDefault ) const;
/** Returns the date/time value of the specified attribute, or the default
value if the attribute is missing or not convertible to a date/time value. */
css::util::DateTime getDateTime( sal_Int32 nAttrToken, const css::util::DateTime& rDefault ) const;
std::vector<sal_Int32> getTokenList(sal_Int32 nAttrToken) const;
private:
css::uno::Reference< css::xml::sax::XFastAttributeList >
mxAttribs;
mutable sax_fastparser::FastAttributeList *mpAttribList;
sax_fastparser::FastAttributeList *getAttribList() const;
};
} // namespace oox
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
