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
195
196
197
198
199
/* -*- 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 _FRAMEWORK_XML_ACCELERATORCONFIGURATIONREADER_HXX_
#define _FRAMEWORK_XML_ACCELERATORCONFIGURATIONREADER_HXX_
#include <accelerators/acceleratorcache.hxx>
#include <accelerators/keymapping.hxx>
#include <macros/xinterface.hxx>
#include <threadhelp/threadhelpbase.hxx>
#include <general.h>
#include <com/sun/star/xml/sax/XDocumentHandler.hpp>
#include <com/sun/star/xml/sax/XLocator.hpp>
#include <salhelper/singletonref.hxx>
#include <cppuhelper/weak.hxx>
#include <rtl/ustring.hxx>
namespace framework{
class AcceleratorConfigurationReader : public css::xml::sax::XDocumentHandler
, private ThreadHelpBase
, public ::cppu::OWeakObject
{
//-------------------------------------------
// const, types
private:
//---------------------------------------
/** @short classification of XML elements. */
enum EXMLElement
{
E_ELEMENT_ACCELERATORLIST,
E_ELEMENT_ITEM
};
//---------------------------------------
/** @short classification of XML attributes. */
enum EXMLAttribute
{
E_ATTRIBUTE_KEYCODE,
E_ATTRIBUTE_MOD_SHIFT,
E_ATTRIBUTE_MOD_MOD1,
E_ATTRIBUTE_MOD_MOD2,
E_ATTRIBUTE_MOD_MOD3,
E_ATTRIBUTE_URL
};
//---------------------------------------
/** @short some namespace defines */
enum EAcceleratorXMLNamespace
{
E_NAMESPACE_ACCEL,
E_NAMESPACE_XLINK
};
//-------------------------------------------
// member
private:
//---------------------------------------
/** @short needed to read the xml configuration. */
css::uno::Reference< css::xml::sax::XDocumentHandler > m_xReader;
//---------------------------------------
/** @short reference to the outside container, where this
reader/writer must work on. */
AcceleratorCache& m_rContainer;
//---------------------------------------
/** @short used to detect if an accelerator list
occures recursive inside xml. */
sal_Bool m_bInsideAcceleratorList;
//---------------------------------------
/** @short used to detect if an accelerator item
occures recursive inside xml. */
sal_Bool m_bInsideAcceleratorItem;
//---------------------------------------
/** @short is used to map key codes to its
string representation.
@descr To perform this operatio is
created only one times and holded
alive forever ...*/
::salhelper::SingletonRef< KeyMapping > m_rKeyMapping;
//---------------------------------------
/** @short provide informations abou the parsing state.
@descr We use it to find out the line and column, where
an error occure.
*/
css::uno::Reference< css::xml::sax::XLocator > m_xLocator;
//-------------------------------------------
// interface
public:
//---------------------------------------
/** @short connect this new reader/writer instance
to an outside container, which should be used
flushed to the underlying XML configuration or
filled from there.
@param rContainer
a reference to the outside container.
*/
AcceleratorConfigurationReader(AcceleratorCache& rContainer);
//---------------------------------------
/** @short does nothing real ... */
virtual ~AcceleratorConfigurationReader();
//---------------------------------------
// XInterface
FWK_DECLARE_XINTERFACE
//---------------------------------------
// XDocumentHandler
virtual void SAL_CALL startDocument()
throw(css::xml::sax::SAXException,
css::uno::RuntimeException );
virtual void SAL_CALL endDocument()
throw(css::xml::sax::SAXException,
css::uno::RuntimeException );
virtual void SAL_CALL startElement(const ::rtl::OUString& sElement ,
const css::uno::Reference< css::xml::sax::XAttributeList >& xAttributeList)
throw(css::xml::sax::SAXException,
css::uno::RuntimeException );
virtual void SAL_CALL endElement(const ::rtl::OUString& sElement)
throw(css::xml::sax::SAXException,
css::uno::RuntimeException );
virtual void SAL_CALL characters(const ::rtl::OUString& sChars)
throw(css::xml::sax::SAXException,
css::uno::RuntimeException );
virtual void SAL_CALL ignorableWhitespace(const ::rtl::OUString& sWhitespaces)
throw(css::xml::sax::SAXException,
css::uno::RuntimeException );
virtual void SAL_CALL processingInstruction(const ::rtl::OUString& sTarget,
const ::rtl::OUString& sData )
throw(css::xml::sax::SAXException,
css::uno::RuntimeException );
virtual void SAL_CALL setDocumentLocator(const css::uno::Reference< css::xml::sax::XLocator >& xLocator)
throw(css::xml::sax::SAXException,
css::uno::RuntimeException );
//-------------------------------------------
// helper
private:
//---------------------------------------
/** TODO document me */
static EXMLElement implst_classifyElement(const ::rtl::OUString& sElement);
//---------------------------------------
/** TODO document me */
static EXMLAttribute implst_classifyAttribute(const ::rtl::OUString& sAttribute);
//---------------------------------------
/** TODO document me */
::rtl::OUString implts_getErrorLineString();
};
} // namespace framework
#endif // _FRAMEWORK_XML_ACCELERATORCONFIGURATIONREADER_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */