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
|
/* -*- 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 <oox/ole/vbamodule.hxx>
#include <com/sun/star/container/XNameContainer.hpp>
#include <com/sun/star/script/ModuleInfo.hpp>
#include <com/sun/star/script/ModuleType.hpp>
#include <com/sun/star/script/vba/XVBAModuleInfo.hpp>
#include <com/sun/star/awt/KeyEvent.hpp>
#include <osl/diagnose.h>
#include <rtl/character.hxx>
#include <o3tl/string_view.hxx>
#include <filter/msfilter/msvbahelper.hxx>
#include <oox/helper/binaryinputstream.hxx>
#include <oox/helper/storagebase.hxx>
#include <oox/helper/textinputstream.hxx>
#include <oox/ole/vbahelper.hxx>
#include <oox/ole/vbainputstream.hxx>
namespace oox::ole {
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::script::vba;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star;
using ::com::sun::star::awt::KeyEvent;
VbaModule::VbaModule( const Reference< XComponentContext >& rxContext,
const Reference< frame::XModel >& rxDocModel,
const OUString& rName, rtl_TextEncoding eTextEnc, bool bExecutable ) :
mxContext( rxContext ),
mxDocModel( rxDocModel ),
maName( rName ),
meTextEnc( eTextEnc ),
mnType( script::ModuleType::UNKNOWN ),
mnOffset( SAL_MAX_UINT32 ),
mbReadOnly( false ),
mbPrivate( false ),
mbExecutable( bExecutable )
{
}
void VbaModule::importDirRecords( BinaryInputStream& rDirStrm )
{
sal_uInt16 nRecId = 0;
StreamDataSequence aRecData;
while( VbaHelper::readDirRecord( nRecId, aRecData, rDirStrm ) && (nRecId != VBA_ID_MODULEEND) )
{
SequenceInputStream aRecStrm( aRecData );
sal_Int32 nRecSize = aRecData.getLength();
switch( nRecId )
{
#define OOX_ENSURE_RECORDSIZE( cond ) OSL_ENSURE( cond, "VbaModule::importDirRecords - invalid record size" )
case VBA_ID_MODULENAME:
OSL_FAIL( "VbaModule::importDirRecords - unexpected MODULENAME record" );
maName = aRecStrm.readCharArrayUC( nRecSize, meTextEnc );
break;
case VBA_ID_MODULENAMEUNICODE:
break;
case VBA_ID_MODULESTREAMNAME:
maStreamName = aRecStrm.readCharArrayUC( nRecSize, meTextEnc );
// Actually the stream name seems the best name to use
// the VBA_ID_MODULENAME name can sometimes be the wrong case
maName = maStreamName;
break;
case VBA_ID_MODULESTREAMNAMEUNICODE:
break;
case VBA_ID_MODULEDOCSTRING:
maDocString = aRecStrm.readCharArrayUC( nRecSize, meTextEnc );
break;
case VBA_ID_MODULEDOCSTRINGUNICODE:
break;
case VBA_ID_MODULEOFFSET:
OOX_ENSURE_RECORDSIZE( nRecSize == 4 );
mnOffset = aRecStrm.readuInt32();
break;
case VBA_ID_MODULEHELPCONTEXT:
OOX_ENSURE_RECORDSIZE( nRecSize == 4 );
break;
case VBA_ID_MODULECOOKIE:
OOX_ENSURE_RECORDSIZE( nRecSize == 2 );
break;
case VBA_ID_MODULETYPEPROCEDURAL:
OOX_ENSURE_RECORDSIZE( nRecSize == 0 );
OSL_ENSURE( mnType == script::ModuleType::UNKNOWN, "VbaModule::importDirRecords - multiple module type records" );
mnType = script::ModuleType::NORMAL;
break;
case VBA_ID_MODULETYPEDOCUMENT:
OOX_ENSURE_RECORDSIZE( nRecSize == 0 );
OSL_ENSURE( mnType == script::ModuleType::UNKNOWN, "VbaModule::importDirRecords - multiple module type records" );
mnType = script::ModuleType::DOCUMENT;
break;
case VBA_ID_MODULEREADONLY:
OOX_ENSURE_RECORDSIZE( nRecSize == 0 );
mbReadOnly = true;
break;
case VBA_ID_MODULEPRIVATE:
OOX_ENSURE_RECORDSIZE( nRecSize == 0 );
mbPrivate = true;
break;
default:
OSL_FAIL( "VbaModule::importDirRecords - unknown module record" );
#undef OOX_ENSURE_RECORDSIZE
}
}
OSL_ENSURE( !maName.isEmpty(), "VbaModule::importDirRecords - missing module name" );
OSL_ENSURE( !maStreamName.isEmpty(), "VbaModule::importDirRecords - missing module stream name" );
OSL_ENSURE( mnType != script::ModuleType::UNKNOWN, "VbaModule::importDirRecords - missing module type" );
OSL_ENSURE( mnOffset < SAL_MAX_UINT32, "VbaModule::importDirRecords - missing module stream offset" );
}
void VbaModule::createAndImportModule( StorageBase& rVbaStrg,
const Reference< container::XNameContainer >& rxBasicLib,
const Reference< container::XNameAccess >& rxDocObjectNA )
{
OUString aVBASourceCode = readSourceCode( rVbaStrg );
createModule( aVBASourceCode, rxBasicLib, rxDocObjectNA );
registerShortcutKeys();
}
void VbaModule::registerShortcutKeys()
{
for (VbaMacroKeyAndMethodBinding const& rKeyBinding : maKeyBindings)
{
try
{
KeyEvent aKeyEvent = ooo::vba::parseKeyEvent(rKeyBinding.msApiKey);
ooo::vba::applyShortCutKeyBinding(mxDocModel, aKeyEvent, rKeyBinding.msMethodName);
}
catch (const Exception&)
{
}
}
}
void VbaModule::createEmptyModule( const Reference< container::XNameContainer >& rxBasicLib,
const Reference< container::XNameAccess >& rxDocObjectNA ) const
{
createModule( u"", rxBasicLib, rxDocObjectNA );
}
OUString VbaModule::readSourceCode( StorageBase& rVbaStrg )
{
OUStringBuffer aSourceCode(512);
static const char sUnmatchedRemovedTag[] = "Rem removed unmatched Sub/End: ";
if( !maStreamName.isEmpty() && (mnOffset != SAL_MAX_UINT32) )
{
BinaryXInputStream aInStrm( rVbaStrg.openInputStream( maStreamName ), true );
OSL_ENSURE( !aInStrm.isEof(), "VbaModule::readSourceCode - cannot open module stream" );
// skip the 'performance cache' stored before the actual source code
aInStrm.seek( mnOffset );
// if stream is still valid, load the source code
if( !aInStrm.isEof() )
{
// decompression starts at current stream position of aInStrm
VbaInputStream aVbaStrm( aInStrm );
// load the source code line-by-line, with some more processing
TextInputStream aVbaTextStrm( mxContext, aVbaStrm, meTextEnc );
struct ProcedurePair
{
bool bInProcedure;
sal_uInt32 nPos;
ProcedurePair() : bInProcedure( false ), nPos( 0 ) {};
} procInfo;
while( !aVbaTextStrm.isEof() )
{
OUString aCodeLine = aVbaTextStrm.readLine();
if( aCodeLine.match( "Attribute " ) )
{
// attribute
int index = aCodeLine.indexOf( ".VB_ProcData.VB_Invoke_Func = " );
if ( index != -1 )
{
// format is
// 'Attribute Procedure.VB_ProcData.VB_Invoke_Func = "*\n14"'
// where 'Procedure' is the procedure name and '*' is the shortcut key
// note: his is only relevant for Excel, seems that
// word doesn't store the shortcut in the module
// attributes
int nSpaceIndex = aCodeLine.indexOf(' ');
OUString sProc = aCodeLine.copy( nSpaceIndex + 1, index - nSpaceIndex - 1);
// for Excel short cut key seems limited to cntrl+'a-z, A-Z'
std::u16string_view sKey = aCodeLine.subView( aCodeLine.lastIndexOf("= ") + 3, 1 );
// only alpha key valid for key shortcut, however the api will accept other keys
if ( rtl::isAsciiAlpha( sKey[ 0 ] ) )
{
// cntrl modifier is explicit ( but could be cntrl+shift ), parseKeyEvent
// will handle and uppercase letter appropriately
OUString sApiKey = OUString::Concat("^") + sKey;
maKeyBindings.push_back({sApiKey, sProc});
}
}
}
else
{
// Hack here to weed out any unmatched End Sub / Sub Foo statements.
// The behaviour of the vba ide practically guarantees the case and
// spacing of Sub statement(s). However, indentation can be arbitrary hence
// the trim.
OUString trimLine( aCodeLine.trim() );
if ( mbExecutable && (
trimLine.match("Sub ") ||
trimLine.match("Public Sub ") ||
trimLine.match("Private Sub ") ||
trimLine.match("Static Sub ") ) )
{
// this should never happen, basic doesn't support nested procedures
// first Sub Foo must be bogus
if ( procInfo.bInProcedure )
{
// comment out the line
aSourceCode.insert( procInfo.nPos, sUnmatchedRemovedTag );
// mark location of this Sub
procInfo.nPos = aSourceCode.getLength();
}
else
{
procInfo.bInProcedure = true;
procInfo.nPos = aSourceCode.getLength();
}
}
else if ( mbExecutable && o3tl::starts_with(o3tl::trim(aCodeLine), u"End Sub") )
{
// un-matched End Sub
if ( !procInfo.bInProcedure )
{
aSourceCode.append( sUnmatchedRemovedTag );
}
else
{
procInfo.bInProcedure = false;
procInfo.nPos = 0;
}
}
// normal source code line
if( !mbExecutable )
aSourceCode.append( "Rem " );
aSourceCode.append( aCodeLine ).append( '\n' );
}
}
}
}
return aSourceCode.makeStringAndClear();
}
void VbaModule::createModule( std::u16string_view rVBASourceCode,
const Reference< container::XNameContainer >& rxBasicLib,
const Reference< container::XNameAccess >& rxDocObjectNA ) const
{
if( maName.isEmpty() )
return;
// prepare the Basic module
script::ModuleInfo aModuleInfo;
aModuleInfo.ModuleType = mnType;
OUStringBuffer aSourceCode(512);
aSourceCode.append( "Rem Attribute VBA_ModuleType=" );
switch( mnType )
{
case script::ModuleType::NORMAL:
aSourceCode.append( "VBAModule" );
break;
case script::ModuleType::CLASS:
aSourceCode.append( "VBAClassModule" );
break;
case script::ModuleType::FORM:
aSourceCode.append( "VBAFormModule" );
// hack from old filter, document Basic should know the XModel, but it doesn't
aModuleInfo.ModuleObject.set( mxDocModel, UNO_QUERY );
break;
case script::ModuleType::DOCUMENT:
aSourceCode.append( "VBADocumentModule" );
// get the VBA implementation object associated to the document module
if( rxDocObjectNA.is() ) try
{
aModuleInfo.ModuleObject.set( rxDocObjectNA->getByName( maName ), UNO_QUERY );
}
catch (const Exception&)
{
}
break;
default:
aSourceCode.append( "VBAUnknown" );
}
aSourceCode.append( '\n' );
if( mbExecutable )
{
aSourceCode.append( "Option VBASupport 1\n" );
if( mnType == script::ModuleType::CLASS )
aSourceCode.append( "Option ClassModule\n" );
}
else
{
// add a subroutine named after the module itself
aSourceCode.append( "Sub " + maName.replace( ' ', '_' ) + "\n" );
}
// append passed VBA source code
aSourceCode.append( rVBASourceCode );
// close the subroutine named after the module
if( !mbExecutable )
aSourceCode.append( "End Sub\n" );
// insert extended module info
try
{
Reference< XVBAModuleInfo > xVBAModuleInfo( rxBasicLib, UNO_QUERY_THROW );
xVBAModuleInfo->insertModuleInfo( maName, aModuleInfo );
}
catch (const Exception&)
{
}
// insert the module into the passed Basic library
try
{
rxBasicLib->insertByName( maName, Any( aSourceCode.makeStringAndClear() ) );
}
catch (const Exception&)
{
OSL_FAIL( "VbaModule::createModule - cannot insert module into library" );
}
}
} // namespace oox::ole
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
