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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429 | /* -*- 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 .
*/
#include <recording/dispatchrecorder.hxx>
#include <com/sun/star/frame/DispatchStatement.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
#include <com/sun/star/script/CannotConvertException.hpp>
#include <com/sun/star/script/Converter.hpp>
#include <o3tl/any.hxx>
#include <osl/diagnose.h>
#include <vcl/svapp.hxx>
#include <typelib/typedescription.h>
using namespace ::com::sun::star::uno;
namespace framework{
// used to mark a dispatch as comment (mostly it indicates an error) Changing of this define will impact all using of such comments...
#define REM_AS_COMMENT "rem "
// XInterface, XTypeProvider, XServiceInfo
DEFINE_XSERVICEINFO_MULTISERVICE_2(<--- There is an unknown macro here somewhere. Configuration is required. If DEFINE_XSERVICEINFO_MULTISERVICE_2 is a macro then please configure it.
DispatchRecorder,
::cppu::OWeakObject,
"com.sun.star.frame.DispatchRecorder",
"com.sun.star.comp.framework.DispatchRecorder")
DEFINE_INIT_SERVICE(
DispatchRecorder,
{
}
)
static void flatten_struct_members(
::std::vector< Any > * vec, void const * data,
typelib_CompoundTypeDescription * pTD )
{
if (pTD->pBaseTypeDescription)
{
flatten_struct_members( vec, data, pTD->pBaseTypeDescription );
}
for ( sal_Int32 nPos = 0; nPos < pTD->nMembers; ++nPos )
{
vec->push_back(
Any( static_cast<char const *>(data) + pTD->pMemberOffsets[ nPos ], pTD->ppTypeRefs[ nPos ] ) );
}
}
static Sequence< Any > make_seq_out_of_struct(
Any const & val )
{
Type const & type = val.getValueType();
TypeClass eTypeClass = type.getTypeClass();
if (TypeClass_STRUCT != eTypeClass && TypeClass_EXCEPTION != eTypeClass)
{
throw RuntimeException(
type.getTypeName() + "is no struct or exception!" );
}
typelib_TypeDescription * pTD = nullptr;
TYPELIB_DANGER_GET( &pTD, type.getTypeLibType() );
OSL_ASSERT( pTD );
if (! pTD)
{
throw RuntimeException(
"cannot get type descr of type " + type.getTypeName() );
}
::std::vector< Any > vec;
vec.reserve( reinterpret_cast<typelib_CompoundTypeDescription *>(pTD)->nMembers ); // good guess
flatten_struct_members( &vec, val.getValue(), reinterpret_cast<typelib_CompoundTypeDescription *>(pTD) );
TYPELIB_DANGER_RELEASE( pTD );
return Sequence< Any >( vec.data(), vec.size() );
}
DispatchRecorder::DispatchRecorder( const css::uno::Reference< css::uno::XComponentContext >& xContext )
: m_nRecordingID(0)
, m_xConverter(css::script::Converter::create(xContext))
{
}
DispatchRecorder::~DispatchRecorder()
{
}
// generate header
void SAL_CALL DispatchRecorder::startRecording( const css::uno::Reference< css::frame::XFrame >& )
{
/* SAFE{ */
/* } */
}
void SAL_CALL DispatchRecorder::recordDispatch( const css::util::URL& aURL,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments )
{
css::frame::DispatchStatement aStatement( aURL.Complete, OUString(), lArguments, 0, false );
m_aStatements.push_back( aStatement );
}
void SAL_CALL DispatchRecorder::recordDispatchAsComment( const css::util::URL& aURL,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments )
{
// last parameter must be set to true -> it's a comment
css::frame::DispatchStatement aStatement( aURL.Complete, OUString(), lArguments, 0, true );
m_aStatements.push_back( aStatement );
}
void SAL_CALL DispatchRecorder::endRecording()
{
SolarMutexGuard g;
m_aStatements.clear();
}
OUString SAL_CALL DispatchRecorder::getRecordedMacro()
{
SolarMutexGuard g;
if ( m_aStatements.empty() )
return OUString();
OUStringBuffer aScriptBuffer;
aScriptBuffer.ensureCapacity(10000);
m_nRecordingID = 1;
aScriptBuffer.append("rem ----------------------------------------------------------------------\n");
aScriptBuffer.append("rem define variables\n");
aScriptBuffer.append("dim document as object\n");
aScriptBuffer.append("dim dispatcher as object\n");
aScriptBuffer.append("rem ----------------------------------------------------------------------\n");
aScriptBuffer.append("rem get access to the document\n");
aScriptBuffer.append("document = ThisComponent.CurrentController.Frame\n");
aScriptBuffer.append("dispatcher = createUnoService(\"com.sun.star.frame.DispatchHelper\")\n\n");
for (auto const& statement : m_aStatements)
implts_recordMacro( statement.aCommand, statement.aArgs, statement.bIsComment, aScriptBuffer );
OUString sScript = aScriptBuffer.makeStringAndClear();
return sScript;
}
void DispatchRecorder::AppendToBuffer( const css::uno::Any& aValue, OUStringBuffer& aArgumentBuffer )
{
// if value == bool
if (aValue.getValueTypeClass() == css::uno::TypeClass_STRUCT )
{
// structs are recorded as arrays, convert to "Sequence of any"
Sequence< Any > aSeq = make_seq_out_of_struct( aValue );
aArgumentBuffer.append("Array(");
for ( sal_Int32 nAny=0; nAny<aSeq.getLength(); nAny++ )
{
AppendToBuffer( aSeq[nAny], aArgumentBuffer );
if ( nAny+1 < aSeq.getLength() )
// not last argument
aArgumentBuffer.append(",");
}
aArgumentBuffer.append(")");
}
else if (aValue.getValueTypeClass() == css::uno::TypeClass_SEQUENCE )
{
// convert to "Sequence of any"
css::uno::Sequence < css::uno::Any > aSeq;
css::uno::Any aNew;
try { aNew = m_xConverter->convertTo( aValue, cppu::UnoType<css::uno::Sequence < css::uno::Any >>::get() ); }
catch (const css::uno::Exception&) {}
aNew >>= aSeq;
aArgumentBuffer.append("Array(");
for ( sal_Int32 nAny=0; nAny<aSeq.getLength(); nAny++ )
{
AppendToBuffer( aSeq[nAny], aArgumentBuffer );
if ( nAny+1 < aSeq.getLength() )
// not last argument
aArgumentBuffer.append(",");
}
aArgumentBuffer.append(")");
}
else if (aValue.getValueTypeClass() == css::uno::TypeClass_STRING )
{
// strings need \"
OUString sVal;
aValue >>= sVal;
// encode non printable characters or '"' by using the CHR$ function
if ( !sVal.isEmpty() )
{
const sal_Unicode* pChars = sVal.getStr();
bool bInString = false;
for ( sal_Int32 nChar=0; nChar<sVal.getLength(); nChar ++ )
{
if ( pChars[nChar] < 32 || pChars[nChar] == '"' )
{
// problematic character detected
if ( bInString )
{
// close current string
aArgumentBuffer.append("\"");
bInString = false;
}
if ( nChar>0 )
// if this is not the first character, parts of the string have already been added
aArgumentBuffer.append("+");
// add the character constant
aArgumentBuffer.append("CHR$(");
aArgumentBuffer.append( static_cast<sal_Int32>(pChars[nChar]) );
aArgumentBuffer.append(")");
}
else
{
if ( !bInString )
{
if ( nChar>0 )
// if this is not the first character, parts of the string have already been added
aArgumentBuffer.append("+");
// start a new string
aArgumentBuffer.append("\"");
bInString = true;
}
aArgumentBuffer.append( pChars[nChar] );
}
}
// close string
if ( bInString )
aArgumentBuffer.append("\"");
}
else
aArgumentBuffer.append("\"\"");
}
else if (auto nVal = o3tl::tryAccess<sal_Unicode>(aValue))
{
// character variables are recorded as strings, back conversion must be handled in client code
aArgumentBuffer.append("\"");
if ( *nVal == '\"' )
// encode \" to \"\"
aArgumentBuffer.append(*nVal);
aArgumentBuffer.append(*nVal);
aArgumentBuffer.append("\"");
}
else
{
css::uno::Any aNew;
try
{
aNew = m_xConverter->convertToSimpleType( aValue, css::uno::TypeClass_STRING );
}
catch (const css::script::CannotConvertException&) {}
catch (const css::uno::Exception&) {}
OUString sVal;
aNew >>= sVal;
if (aValue.getValueTypeClass() == css::uno::TypeClass_ENUM )
{
OUString aName = aValue.getValueType().getTypeName();
aArgumentBuffer.append( aName );
aArgumentBuffer.append(".");
}
aArgumentBuffer.append(sVal);
}
}
void DispatchRecorder::implts_recordMacro( const OUString& aURL,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
bool bAsComment, OUStringBuffer& aScriptBuffer )
{
OUStringBuffer aArgumentBuffer(1000);
// this value is used to name the arrays of aArgumentBuffer
OUString sArrayName = "args" + OUString::number(m_nRecordingID);
aScriptBuffer.append("rem ----------------------------------------------------------------------\n");
sal_Int32 nLength = lArguments.getLength();
sal_Int32 nValidArgs = 0;
for( sal_Int32 i=0; i<nLength; ++i )
{
if(!lArguments[i].Value.hasValue())
continue;
OUStringBuffer sValBuffer(100);
try
{
AppendToBuffer(lArguments[i].Value, sValBuffer);
}
catch(const css::uno::Exception&)
{
sValBuffer.setLength(0);
}
if (sValBuffer.isEmpty())
continue;
{
// add arg().Name
if(bAsComment)
aArgumentBuffer.append(REM_AS_COMMENT);
aArgumentBuffer.append (sArrayName);
aArgumentBuffer.append("(");
aArgumentBuffer.append (nValidArgs);
aArgumentBuffer.append(").Name = \"");
aArgumentBuffer.append (lArguments[i].Name);
aArgumentBuffer.append("\"\n");
// add arg().Value
if(bAsComment)
aArgumentBuffer.append(REM_AS_COMMENT);
aArgumentBuffer.append (sArrayName);
aArgumentBuffer.append("(");
aArgumentBuffer.append (nValidArgs);
aArgumentBuffer.append(").Value = ");
aArgumentBuffer.append (sValBuffer.makeStringAndClear());
aArgumentBuffer.append("\n");
++nValidArgs;
}
}
// if aArgumentBuffer exist - pack it into the aScriptBuffer
if(nValidArgs>0)
{
if(bAsComment)
aScriptBuffer.append(REM_AS_COMMENT);
aScriptBuffer.append("dim ");
aScriptBuffer.append (sArrayName);
aScriptBuffer.append("(");
aScriptBuffer.append (static_cast<sal_Int32>(nValidArgs-1)); // 0 based!
aScriptBuffer.append(") as new com.sun.star.beans.PropertyValue\n");
aScriptBuffer.append (aArgumentBuffer.makeStringAndClear());
aScriptBuffer.append("\n");
}
// add code for dispatches
if(bAsComment)
aScriptBuffer.append(REM_AS_COMMENT);
aScriptBuffer.append("dispatcher.executeDispatch(document, \"");
aScriptBuffer.append(aURL);
aScriptBuffer.append("\", \"\", 0, ");
if(nValidArgs<1)
aScriptBuffer.append("Array()");
else
{
aScriptBuffer.append( sArrayName );
aScriptBuffer.append("()");
}
aScriptBuffer.append(")\n\n");
/* SAFE { */
m_nRecordingID++;
/* } */
}
css::uno::Type SAL_CALL DispatchRecorder::getElementType()
{
return cppu::UnoType<css::frame::DispatchStatement>::get();
}
sal_Bool SAL_CALL DispatchRecorder::hasElements()
{
return (! m_aStatements.empty());
}
sal_Int32 SAL_CALL DispatchRecorder::getCount()
{
return m_aStatements.size();
}
css::uno::Any SAL_CALL DispatchRecorder::getByIndex(sal_Int32 idx)
{
if (idx >= static_cast<sal_Int32>(m_aStatements.size())) {
throw css::lang::IndexOutOfBoundsException( "Dispatch recorder out of bounds" );
}
Any element(&m_aStatements[idx],
cppu::UnoType<css::frame::DispatchStatement>::get());
return element;
}
void SAL_CALL DispatchRecorder::replaceByIndex(sal_Int32 idx, const css::uno::Any& element)
{
if (element.getValueType() !=
cppu::UnoType<css::frame::DispatchStatement>::get()) {
throw css::lang::IllegalArgumentException(
"Illegal argument in dispatch recorder",
Reference< XInterface >(), 2 );
}
if (idx >= static_cast<sal_Int32>(m_aStatements.size())) {
throw css::lang::IndexOutOfBoundsException(
"Dispatch recorder out of bounds" );
}
auto pStatement = o3tl::doAccess<css::frame::DispatchStatement>(element);
css::frame::DispatchStatement aStatement(
pStatement->aCommand,
pStatement->aTarget,
pStatement->aArgs,
pStatement->nFlags,
pStatement->bIsComment);
m_aStatements[idx] = aStatement;
}
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|