| blob | beb0d16f1306eb16734af583f7351835fbfb4c6f |
3 <script:module xmlns:script="http://openoffice.org/2000/script" script:name="SF_PythonHelper" script:language="StarBasic" script:moduleType="normal">REM =======================================================================================================================
4 REM === The ScriptForge library and its associated libraries are part of the LibreOffice project. ===
5 REM === Full documentation is available on https://help.libreoffice.org/ ===
6 REM =======================================================================================================================
8 Option Compatible
9 Option Explicit
11 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12 ''' SF_PythonHelper (aka Basic)
13 ''' ===============
15 ''' Implemented as a usual Basic module
16 '''
18 ''' Service invocations: Next Python code lines are equivalent:
21 '''
22 ''' This service proposes a collection of methods to be executed in a Python context
23 ''' to simulate the exact behaviour of the identical Basic builtin method.
24 ''' Typical example:
26 '''
28 ''' It dispatches Python script requests to execute Basic services to the
29 ''' appropriate properties and methods via dynamic call techniques
30 '''
31 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
33 REM ================================================================== EXCEPTIONS
35 REM ============================================================ MODULE CONSTANTS
37 REM ===================================================== CONSTRUCTOR/DESTRUCTOR
39 REM -----------------------------------------------------------------------------
40 Public Function Dispose() As Variant
41 Set Dispose = Nothing
42 End Function ' ScriptForge.SF_PythonHelper Explicit destructor
44 REM ================================================================== PROPERTIES
46 REM -----------------------------------------------------------------------------
47 Property Get ObjectType As String
48 ''' Only to enable object representation
50 End Property ' ScriptForge.SF_PythonHelper.ObjectType
52 REM -----------------------------------------------------------------------------
53 Property Get ServiceName As String
54 ''' Internal use
56 End Property ' ScriptForge.SF_PythonHelper.ServiceName
58 REM ============================================================== PUBLIC METHODS
60 REM -----------------------------------------------------------------------------
61 Public Function PyCDate(ByVal DateArg As Variant) As Variant
62 ''' Convenient function to replicate CDate() in Python scripts
63 ''' Args:
64 ''' DateArg: a date as a string or as a double
65 ''' Returns:
66 ''' The converted date as a UNO DateTime structure
67 ''' If the input argument could not be recognized as a date, return the argument unchanged
68 ''' Example: (Python code)
71 Dim vDate As Variant ' Return value
75 On Local Error GoTo Catch
76 vDate = Null
78 Check:
79 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
81 Try:
82 vDate = CDate(DateArg)
84 Finally:
85 If VarType(vDate) = V_DATE Then PyCDate = CDateToUnoDateTime(vDate) Else PyCDate = DateArg
86 SF_Utils._ExitFunction(cstThisSub)
87 Exit Function
88 Catch:
89 On Local Error GoTo 0
90 GoTo Finally
91 End Function ' ScriptForge.SF_PythonHelper.PyCDate
93 REM -----------------------------------------------------------------------------
94 Public Function PyConvertFromUrl(ByVal FileName As Variant) As String
95 ''' Convenient function to replicate ConvertFromUrl() in Python scripts
96 ''' Args:
97 ''' FileName: a string representing a file in URL format
98 ''' Returns:
99 ''' The same file name in native operating system notation
100 ''' Example: (Python code)
103 Dim sFileName As String ' Return value
107 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
108 sFileName = ""
110 Check:
111 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
113 Try:
114 sFileName = ConvertFromUrl(FileName)
116 Finally:
117 PyConvertFromUrl = sFileName
118 SF_Utils._ExitFunction(cstThisSub)
119 Exit Function
120 Catch:
121 GoTo Finally
122 End Function ' ScriptForge.SF_PythonHelper.PyConvertFromUrl
124 REM -----------------------------------------------------------------------------
125 Public Function PyConvertToUrl(ByVal FileName As Variant) As String
126 ''' Convenient function to replicate ConvertToUrl() in Python scripts
127 ''' Args:
128 ''' FileName: a string representing a file in native operating system notation
129 ''' Returns:
130 ''' The same file name in URL format
131 ''' Example: (Python code)
134 Dim sFileName As String ' Return value
138 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
139 sFileName = ""
141 Check:
142 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
144 Try:
145 sFileName = ConvertToUrl(FileName)
147 Finally:
148 PyConvertToUrl = sFileName
149 SF_Utils._ExitFunction(cstThisSub)
150 Exit Function
151 Catch:
152 GoTo Finally
153 End Function ' ScriptForge.SF_PythonHelper.PyConvertToUrl
155 REM -----------------------------------------------------------------------------
156 Public Function PyCreateUnoService(ByVal UnoService As Variant) As Variant
157 ''' Convenient function to replicate CreateUnoService() in Python scripts
158 ''' Args:
159 ''' UnoService: a string representing the service to create
160 ''' Returns:
161 ''' A UNO object
162 ''' Example: (Python code)
163 ''' a = bas.CreateUnoService('com.sun.star.i18n.CharacterClassification')
165 Dim vUno As Variant ' Return value
169 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
170 Set vUno = Nothing
172 Check:
173 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
175 Try:
176 Set vUno = CreateUnoService(UnoService)
178 Finally:
179 Set PyCreateUnoService = vUno
180 SF_Utils._ExitFunction(cstThisSub)
181 Exit Function
182 Catch:
183 GoTo Finally
184 End Function ' ScriptForge.SF_PythonHelper.PyCreateUnoService
186 REM -----------------------------------------------------------------------------
187 Public Function PyDateAdd(ByVal Add As Variant _
188 , ByVal Count As Variant _
189 , ByVal DateArg As Variant _
190 ) As Variant
191 ''' Convenient function to replicate DateAdd() in Python scripts
192 ''' Args:
193 ''' Add: The unit to add
194 ''' Count: how many times to add (might be negative)
195 ''' DateArg: a date as a com.sun.star.util.DateTime UNO structure
196 ''' Returns:
197 ''' The new date as a string in iso format
198 ''' Example: (Python code)
201 Dim vNewDate As Variant ' Return value
202 Dim vDate As Date ' Alias of DateArg
206 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
207 vNewDate = ""
209 Check:
210 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
212 Try:
213 If VarType(DateArg) = V_OBJECT Then
214 vDate = CDateFromUnoDateTime(DateArg)
215 Else
216 vDate = SF_Utils._CStrToDate(DateArg)
217 End If
218 vNewDate = DateAdd(Add, Count, vDate)
220 Finally:
221 If VarType(vNewDate) = V_DATE Then PyDateAdd = CDateToUnoDateTime(vNewDate) Else PyDateAdd = vNewDate
222 SF_Utils._ExitFunction(cstThisSub)
223 Exit Function
224 Catch:
225 GoTo Finally
226 End Function ' ScriptForge.SF_PythonHelper.PyDateAdd
228 REM -----------------------------------------------------------------------------
229 Public Function PyDateDiff(ByVal Add As Variant _
230 , ByVal Date1 As Variant _
231 , ByVal Date2 As Variant _
232 , ByVal WeekStart As Variant _
233 , ByVal YearStart As Variant _
234 ) As Long
235 ''' Convenient function to replicate DateDiff() in Python scripts
236 ''' Args:
237 ''' Add: The unit of the date interval
238 ''' Date1, Date2: the two dates to be compared
239 ''' WeekStart: the starting day of a week
240 ''' YearStart: the starting week of a year
241 ''' Returns:
242 ''' The number of intervals expressed in Adds
243 ''' Example: (Python code)
244 ''' a = bas.DateDiff('d', bas.DateAdd('d', 1, bas.Now()), bas.Now()) ' -1 day
246 Dim lDiff As Long ' Return value
247 Dim vDate1 As Date ' Alias of Date1
248 Dim vDate2 As Date ' Alias of Date2
252 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
253 lDiff = 0
255 Check:
256 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
258 Try:
259 If VarType(Date1) = V_OBJECT Then
260 vDate1 = CDateFromUnoDateTime(Date1)
261 Else
262 vDate1 = SF_Utils._CStrToDate(Date1)
263 End If
264 If VarType(Date2) = V_OBJECT Then
265 vDate2 = CDateFromUnoDateTime(Date2)
266 Else
267 vDate2 = SF_Utils._CStrToDate(Date2)
268 End If
269 lDiff = DateDiff(Add, vDate1, vDate2, WeekStart, YearStart)
272 Finally:
273 PyDateDiff = lDiff
274 SF_Utils._ExitFunction(cstThisSub)
275 Exit Function
276 Catch:
277 GoTo Finally
278 End Function ' ScriptForge.SF_PythonHelper.PyDateDiff
280 REM -----------------------------------------------------------------------------
281 Public Function PyDatePart(ByVal Add As Variant _
282 , ByVal DateArg As Variant _
283 , ByVal WeekStart As Variant _
284 , ByVal YearStart As Variant _
285 ) As Long
286 ''' Convenient function to replicate DatePart() in Python scripts
287 ''' Args:
288 ''' Add: The unit of the date interval
289 ''' DateArg: The date from which to extract a part
290 ''' WeekStart: the starting day of a week
291 ''' YearStart: the starting week of a year
292 ''' Returns:
293 ''' The specified part of the date
294 ''' Example: (Python code)
297 Dim lPart As Long ' Return value
298 Dim vDate As Date ' Alias of DateArg
302 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
303 lPart = 0
305 Check:
306 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
308 Try:
309 If VarType(DateArg) = V_OBJECT Then
310 vDate = CDateFromUnoDateTime(DateArg)
311 Else
312 vDate = SF_Utils._CStrToDate(DateArg)
313 End If
314 lPart = DatePart(Add, vDate, WeekStart, YearStart)
317 Finally:
318 PyDatePart = lPart
319 SF_Utils._ExitFunction(cstThisSub)
320 Exit Function
321 Catch:
322 GoTo Finally
323 End Function ' ScriptForge.SF_PythonHelper.PyDatePart
325 REM -----------------------------------------------------------------------------
326 Public Function PyDateValue(ByVal DateArg As Variant) As Variant
327 ''' Convenient function to replicate DateValue() in Python scripts
328 ''' Args:
329 ''' DateArg: a date as a string
330 ''' Returns:
331 ''' The converted date as a UNO DateTime structure
332 ''' Example: (Python code)
335 Dim vDate As Variant ' Return value
339 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
340 vDate = ""
342 Check:
343 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
345 Try:
346 vDate = DateValue(DateArg)
348 Finally:
349 If VarType(vDate) = V_DATE Then PyDateValue = CDateToUnoDateTime(vDate) Else PyDateValue = vDate
350 SF_Utils._ExitFunction(cstThisSub)
351 Exit Function
352 Catch:
353 GoTo Finally
354 End Function ' ScriptForge.SF_PythonHelper.PyDateValue
356 REM -----------------------------------------------------------------------------
357 Public Function PyFormat(ByVal Value As Variant _
358 , ByVal Pattern As Variant _
359 ) As String
360 ''' Convenient function to replicate Format() in Python scripts
361 ''' Args:
362 ''' Value: a date or a number
363 ''' Pattern: the format to apply
364 ''' Returns:
365 ''' The formatted value
366 ''' Example: (Python code)
369 Dim sFormat As String ' Return value
370 Dim vValue As Variant ' Alias of Value
374 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
375 sFormat = ""
377 Check:
378 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
380 Try:
381 If VarType(Value) = V_OBJECT Then vValue = CDateFromUnoDateTime(Value) ELse vValue = Value
382 If IsEmpty(Pattern) Or Len(Pattern) = 0 Then sFormat = Str(vValue) Else sFormat = Format(vValue, Pattern)
385 Finally:
386 PyFormat = sFormat
387 SF_Utils._ExitFunction(cstThisSub)
388 Exit Function
389 Catch:
390 GoTo Finally
391 End Function ' ScriptForge.SF_PythonHelper.PyFormat
393 REM -----------------------------------------------------------------------------
394 Public Function PyGetGuiType() As Integer
395 ''' Convenient function to replicate GetGuiType() in Python scripts
396 ''' Args:
397 ''' Returns:
398 ''' The GetGuiType value
399 ''' Example: (Python code)
400 ''' MsgBox bas.GetGuiType()
403 Const cstSubArgs = ""
405 Check:
406 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
408 Try:
409 PyGetGuiType = GetGuiType()
412 Finally:
413 SF_Utils._ExitFunction(cstThisSub)
414 Exit Function
415 End Function ' ScriptForge.SF_PythonHelper.PyGetGuiType
417 REM -----------------------------------------------------------------------------
418 Public Function PyGetSystemTicks() As Long
419 ''' Convenient function to replicate GetSystemTicks() in Python scripts
420 ''' Args:
421 ''' Returns:
422 ''' The GetSystemTicks value
423 ''' Example: (Python code)
424 ''' MsgBox bas.GetSystemTicks()
427 Const cstSubArgs = ""
429 Check:
430 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
432 Try:
433 PyGetSystemTicks = GetSystemTicks()
436 Finally:
437 SF_Utils._ExitFunction(cstThisSub)
438 Exit Function
439 End Function ' ScriptForge.SF_PythonHelper.PyGetSystemTicks
441 REM -----------------------------------------------------------------------------
442 Public Function PyGlobalScope(ByVal Library As Variant) As Object
443 ''' Convenient function to replicate GlobalScope() in Python scripts
444 ''' Args:
446 ''' Returns:
447 ''' The GlobalScope value
448 ''' Example: (Python code)
449 ''' MsgBox bas.GlobalScope.BasicLibraries()
452 Const cstSubArgs = ""
454 Check:
455 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
457 Try:
458 Select Case Library
460 PyGlobalScope = GlobalScope.BasicLibraries()
462 PyGlobalScope = GlobalScope.DialogLibraries()
463 Case Else
464 End Select
466 Finally:
467 SF_Utils._ExitFunction(cstThisSub)
468 Exit Function
469 End Function ' ScriptForge.SF_PythonHelper.PyGlobalScope
471 REM -----------------------------------------------------------------------------
472 Public Function PyInputBox(ByVal Msg As Variant _
473 , ByVal Title As Variant _
474 , ByVal Default As Variant _
475 , Optional ByVal XPosTwips As Variant _
476 , Optional ByVal YPosTwips As Variant _
477 ) As String
478 ''' Convenient function to replicate InputBox() in Python scripts
479 ''' Args:
480 ''' Msg: String expression displayed as the message in the dialog box
481 ''' Title: String expression displayed in the title bar of the dialog box
482 ''' Default: String expression displayed in the text box as default if no other input is given
483 ''' XPosTwips: Integer expression that specifies the horizontal position of the dialog
484 ''' YPosTwips: Integer expression that specifies the vertical position of the dialog
485 ''' If XPosTwips and YPosTwips are omitted, the dialog is centered on the screen
486 ''' The position is specified in twips.
487 ''' Returns:
489 ''' Example: (Python code)
492 Dim sInput As String ' Return value
494 Const cstSubArgs = "msg, [title=''], [default=''], [xpostwips], [ypostwips]"
496 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
497 sInput = ""
499 Check:
500 If IsMissing(YPosTwips) Then YPosTwips = 1
501 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
503 Try:
504 If IsMissing(XPosTwips) Then
505 sInput = InputBox(Msg, Title, Default)
506 Else
507 sInput = InputBox(Msg, Title, Default, XPosTwips, YPosTwips)
508 End If
510 Finally:
511 PyInputBox = sInput
512 SF_Utils._ExitFunction(cstThisSub)
513 Exit Function
514 Catch:
515 GoTo Finally
516 End Function ' ScriptForge.SF_PythonHelper.PyInputBox
518 REM -----------------------------------------------------------------------------
519 Public Function PyMsgBox(ByVal Text As Variant _
520 , ByVal DialogType As Variant _
521 , ByVal DialogTitle As Variant _
522 ) As Integer
523 ''' Convenient function to replicate MsgBox() in Python scripts
524 ''' Args:
525 ''' Text: String expression displayed as a message in the dialog box
526 ''' DialogType: Any integer expression that defines the number and type of buttons or icons displayed
527 ''' DialogTitle: String expression displayed in the title bar of the dialog
528 ''' Returns:
529 ''' The pressed button
530 ''' Example: (Python code)
531 ''' a = bas.MsgBox ('Please press a button:', bas.MB_EXCLAMATION, 'Dear User')
533 Dim iMsg As Integer ' Return value
537 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
538 iMsg = -1
540 Check:
541 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
543 Try:
544 iMsg = MsgBox(Text, DialogType, DialogTitle)
546 Finally:
547 PyMsgBox = iMsg
548 SF_Utils._ExitFunction(cstThisSub)
549 Exit Function
550 Catch:
551 GoTo Finally
552 End Function ' ScriptForge.SF_PythonHelper.PyMsgBox
554 REM ============================================================= PRIVATE METHODS
556 REM -----------------------------------------------------------------------------
557 Public Function _PythonDispatcher(ByRef BasicObject As Variant _
558 , ByVal CallType As Variant _
559 , ByVal Script As Variant _
560 , ParamArray Args() As Variant _
561 ) As Variant
562 ''' Called from Python only
563 ''' The method calls the method Script associated with the BasicObject class or module
564 ''' with the given arguments
565 ''' The invocation of the method can be a Property Get, Property Let or a usual call
567 ''' The implementation intends to be as AGNOSTIC as possible in terms of objects nature and methods called
568 ''' The method returns the value effectively returned by the called component,
570 ''' Args:
571 ''' BasicObject: a module or a class instance - May also be the reserved string: "SF_Services"
572 ''' CallType: one of the constants applicable to a CallByName statement + optional protocol flags
573 ''' Script: the name of the method or property
574 ''' Args: the arguments to pass to the method. Input arguments can contain symbolic constants for Null, Missing, etc.
575 ''' Returns:
579 ''' Null, Empty and Nothing have different vartypes but return all None to Python
580 ''' Additionally, when array:
582 ''' Additionally, when Basic object:
587 ''' When an error occurs Python receives None as a scalar. This determines the occurrence of a failure
589 Dim vReturn As Variant ' The value returned by the invoked property or method
590 Dim vReturnArray As Variant ' Return value
591 Dim vBasicObject As Variant ' Alias of BasicObject to avoid "Object reference not set" error
592 Dim iNbArgs As Integer ' Number of valid input arguments
593 Dim vArg As Variant ' Alias for a single argument
594 Dim vArgs() As Variant ' Alias for Args()
595 Dim sScript As String ' Argument of ExecuteBasicScript()
596 Dim vParams As Variant ' Array of arguments to pass to a ParamArray
597 Dim sObjectType As String ' Alias of object.ObjectType
598 Dim sServiceName As String ' Alias of BasicObject.ServiceName
599 Dim bBasicClass As Boolean ' True when BasicObject is a class
600 Dim sLibrary As String ' Library where the object belongs to
601 Dim bUno As Boolean ' Return value is a UNO object
602 Dim bDict As Boolean ' Return value is a Basic SF_Dictionary class instance
603 Dim oDict As Object ' SF_Dictionary class instance
604 Dim oObjDesc As Object ' _ObjectDescriptor type
605 Dim iDims As Integer ' # of dims of vReturn when array
606 Dim sess As Object : Set sess = ScriptForge.SF_Session
607 Dim i As Long, j As Long
609 ' Conventional special input or output values
610 Const cstNoArgs = "+++NOARGS+++", cstSymEmpty = "+++EMPTY+++", cstSymNull = "+++NULL+++", cstSymMissing = "+++MISSING+++"
612 ' https://support.office.com/en-us/article/CallByName-fonction-49ce9475-c315-4f13-8d35-e98cfe98729a
613 ' Determines the CallType
615 ' Protocol flags
625 ' Returned object nature
628 Check:
629 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
630 _PythonDispatcher = Null
632 ' Ignore Null basic objects (Null = Null or Nothing)
633 If IsNull(BasicObject) Or IsEmpty(BasicObject) Then GoTo Catch
635 ' Reinterpret arguments one by one into vArgs
636 ' - convert UNO dates/times
637 ' - identify conventional NoArgs/Empty/Null/Missing constants
638 ' - convert arrays of property values into Dictionary
639 iNbArgs = -1
640 vArgs = Array()
643 For i = 0 To UBound(Args)
644 vArg = Args(i)
645 ' Are there arguments ?
646 If i = 0 And VarType(vArg) = V_STRING Then
647 If vArg = cstNoArgs Then Exit For
648 End If
650 If i = 0 And (( CallType And cstObject ) = cstObject) And SF_Utils._VarTypeExt(vArg) = V_NUMERIC Then
652 If vArg > UBound(_SF_.PythonStorage) Then GoTo Catch
653 vArg = _SF_.PythonStorage(vArg)
654 ' Is argument a symbolic constant for Null, Empty, ... , or a date, or a dictionary ?
655 ElseIf VarType(vArg) = V_STRING Then
656 If Len(vArg) = 0 Then
657 ElseIf vArg = cstSymEmpty Then
658 vArg = Empty
659 ElseIf vArg = cstSymNull Then
660 vArg = Null
661 ElseIf vArg = cstSymMissing Then
662 Exit For ' Next arguments must be missing also
663 End If
664 ElseIf VarType(vArg) = V_OBJECT Then
665 If ( CallType And cstDateArg ) = cstDateArg Then vArg = CDateFromUnoDateTime(vArg)
666 ElseIf ( CallType And cstDictArg ) = cstDictArg Then
667 If IsArray(vArg) Then
670 ' Create a dictionary - keys in Python dicts are case-sensitive
672 oDict.ImportFromPropertyValues(vArg, Overwrite := True)
673 vArg = oDict
674 End If
675 End If
676 End If
677 End If
678 iNbArgs = iNbArgs + 1
680 ReDim Preserve vArgs(iNbArgs)
681 vArgs(iNbArgs) = vArg
682 Next i
683 End If
685 Try:
686 ' Dispatching strategy: based on next constraints
688 ' The CallByName function fails when returning an array
690 ' (3) Passing 2D arrays through a script provider always transform it into a sequence of sequences
691 ' (4) The CallByName function takes exclusive control on the targeted object up to its exit
693 ' RULES:
696 ' EXCEPTIONS:
697 ' 3. Methods in usual modules are called by ExecuteBasicScript() when they manipulate arrays
698 ' 4. Methods in class modules using a 2D array or returning arrays, or methods using ParamArray,
699 ''' are hardcoded as exceptions or are not implemented
700 ' 5. Due to constraint (4), a predefined list of method calls must be hardcoded to avoid blocking use of CallByName
701 ' The concerned methods are flagged with cstHardCode
703 With _SF_
705 If IsEmpty(.PythonStorage) Then ._InitPythonStorage()
706 ' Reset any error
707 ._Stackreset()
708 ' Set Python trigger to manage signatures in error messages
709 .TriggeredByPython = True
710 End With
712 Select case VarType(BasicObject)
713 Case V_STRING
714 ' Special entry for CreateScriptService()
715 vBasicObject = BasicObject
718 Select Case UBound(vParams)
722 Case 2 : vReturn = SF_Services.CreateScriptService(vArgs(0), vParams(0), vParams(1), vParams(2))
723 Case 3 : vReturn = SF_Services.CreateScriptService(vArgs(0), vParams(0), vParams(1), vParams(2), vParams(3))
724 Case 4 : vReturn = SF_Services.CreateScriptService(vArgs(0), vParams(0), vParams(1), vParams(2), vParams(3), vParams(4))
725 End Select
726 End If
727 If VarType(vReturn) = V_OBJECT And Not IsNull(vReturn) Then
728 vBasicObject = vReturn
729 sObjectType = vBasicObject.ObjectType
731 End If
733 ' Implement dispatching strategy
734 Case V_INTEGER
736 If BasicObject > UBound(_SF_.PythonStorage) Then GoTo Catch
737 vBasicObject = _SF_.PythonStorage(BasicObject)
738 sObjectType = vBasicObject.ObjectType
739 sServiceName = vBasicObject.ServiceName
745 ' Methods in standard modules are called by ExecuteBasicScript() when arrays are returned
746 If Not bBasicClass And (CallType And vbMethod) = vbMethod And (CallType And cstRetArray) = cstRetArray Then
748 ' Force validation in targeted function, not in ExecuteBasicScript()
749 _SF_.StackLevel = -1
750 Select Case UBound(vArgs)
751 Case -1 : vReturn = sess.ExecuteBasicScript(, sScript)
756 Case 4 : vReturn = sess.ExecuteBasicScript(, sScript, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4))
757 Case 5 : vReturn = sess.ExecuteBasicScript(, sScript, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5))
758 Case 6 : vReturn = sess.ExecuteBasicScript(, sScript, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6))
759 Case 7 : vReturn = sess.ExecuteBasicScript(, sScript, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7))
760 End Select
761 _SF_.StackLevel = 0
763 ' Properties in any service are got and set with obj.GetProperty/SetProperty(...)
764 ElseIf (CallType And vbGet) = vbGet Then ' In some cases (Calc ...) GetProperty may have an argument
765 If UBound(vArgs) < 0 Then vReturn = vBasicObject.GetProperty(Script) Else vReturn = vBasicObject.GetProperty(Script, vArgs(0))
766 ElseIf (CallType And vbLet) = vbLet Then
767 vReturn = vBasicObject.SetProperty(Script, vArgs(0))
769 ' Methods in class modules using a 2D array or returning arrays are hardcoded as exceptions. Bug #138155
770 ElseIf ((CallType And vbMethod) + (CallType And cstArgArray)) = vbMethod + cstArgArray Or _
771 ((CallType And vbMethod) + (CallType And cstRetArray)) = vbMethod + cstRetArray Then
773 vReturn = vBasicObject.Methods()
775 vReturn = vBasicObject.Properties()
776 Else
777 Select Case sServiceName
779 If Script = "GetRows" Then vReturn = vBasicObject.GetRows(vArgs(0), vArgs(1), vArgs(2), vArgs(3))
785 If Script = "SetTableData" Then vReturn = vBasicObject.SetTableData(vArgs(0), vArgs(1), vArgs(2))
787 Select Case Script
790 Case "Styles" : vReturn = vBasicObject.Styles(vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5))
792 End Select
794 Select Case Script
799 End Select
801 Select Case Script
810 Case "Styles" : vReturn = vBasicObject.Styles(vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5))
812 End Select
814 Select Case Script
817 End Select
821 Select Case Script
825 End Select
827 Select Case Script
830 Case "Styles" : vReturn = vBasicObject.Styles(vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5))
832 End Select
834 Select Case Script
836 End Select
837 End Select
838 End If
840 ' Specific methods in class modules may better not be executed with CallByName() because they do not return immediately
841 ElseIf bBasicClass And ((CallType And vbMethod) + (CallType And cstHardCode)) = vbMethod + cstHardCode Then
842 Select Case sServiceName
844 Select Case Script
846 End Select
847 End Select
849 ' Methods in all modules are invoked with CallByName
850 ElseIf ((CallType And vbMethod) = vbMethod) Then
851 Select Case UBound(vArgs)
852 ' Dirty alternatives to process usual and ParamArray cases
853 ' But, up to ... how many ?
856 Case -1 : vReturn = CallByName(vBasicObject, Script, vbMethod)
860 Case 3 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3))
861 Case 4 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4))
862 Case 5 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5))
863 Case 6 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6))
864 Case 7 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7))
865 Case 8 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
866 , vArgs(8))
867 Case 9 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
869 Case 10 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
871 Case 11 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
873 Case 12, 13 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
875 Case 14, 15 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
877 Case 16, 17 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
878 , vArgs(8), vArgs(9), vArgs(10), vArgs(11), vArgs(12), vArgs(13), vArgs(14), vArgs(15), vArgs(16))
879 Case 18, 19 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
880 , vArgs(8), vArgs(9), vArgs(10), vArgs(11), vArgs(12), vArgs(13), vArgs(14), vArgs(15), vArgs(16), vArgs(17), vArgs(18))
881 Case 20, 21 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
882 , vArgs(8), vArgs(9), vArgs(10), vArgs(11), vArgs(12), vArgs(13), vArgs(14), vArgs(15), vArgs(16), vArgs(17), vArgs(18) _
884 Case 22, 23 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
885 , vArgs(8), vArgs(9), vArgs(10), vArgs(11), vArgs(12), vArgs(13), vArgs(14), vArgs(15), vArgs(16), vArgs(17), vArgs(18) _
887 Case 24, 25 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
888 , vArgs(8), vArgs(9), vArgs(10), vArgs(11), vArgs(12), vArgs(13), vArgs(14), vArgs(15), vArgs(16), vArgs(17), vArgs(18) _
890 Case 26, 27 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
891 , vArgs(8), vArgs(9), vArgs(10), vArgs(11), vArgs(12), vArgs(13), vArgs(14), vArgs(15), vArgs(16), vArgs(17), vArgs(18) _
893 Case >= 28 : vReturn = CallByName(vBasicObject, Script, vbMethod, vArgs(0), vArgs(1), vArgs(2), vArgs(3), vArgs(4), vArgs(5), vArgs(6), vArgs(7) _
894 , vArgs(8), vArgs(9), vArgs(10), vArgs(11), vArgs(12), vArgs(13), vArgs(14), vArgs(15), vArgs(16), vArgs(17), vArgs(18) _
895 , vArgs(19), vArgs(20), vArgs(21), vArgs(22), vArgs(23), vArgs(24), vArgs(25), vArgs(26), vArgs(27), vArgs(28))
896 End Select
897 End If
899 ' Post processing
900 If (CallType And cstPost) = cstPost Then
902 ' Special case: Dispose() must update the cache for class objects created in Python scripts
903 Set _SF_.PythonStorage(BasicObject) = Nothing
904 End If
905 End If
906 Case Else
907 End Select
909 ' Format the returned array
910 vReturnArray = Array()
911 ' Distinguish: Basic object
912 ' UNO object
913 ' Dictionary
914 ' Array
915 ' Scalar
916 If IsArray(vReturn) Then
918 iDims = SF_Array.CountDims(vReturn)
919 ' Replace dates by UNO format
920 If iDims = 1 Then
921 For i = LBound(vReturn) To UBound(vReturn)
922 If VarType(vReturn(i)) = V_DATE Then vReturn(i) = CDateToUnoDateTime(vReturn(i))
923 Next i
924 ElseIf iDims = 2 Then
927 If VarType(vReturn(i, j)) = V_DATE Then vReturn(i, j) = CDateToUnoDateTime(vReturn(i, j))
928 Next j
929 Next i
930 End If
931 vReturnArray(0) = vReturn ' 2D arrays are flattened by the script provider when returning to Python
932 vReturnArray(1) = VarType(vReturn)
933 vReturnArray(2) = iDims
934 ElseIf VarType(vReturn) = V_OBJECT And Not IsNull(vReturn) Then
935 ' Uno or not Uno ?
936 bUno = False
937 If (CallType And cstUno) = cstUno Then ' UNO considered only when pre-announced in CallType
938 Set oObjDesc = SF_Utils._VarTypeObj(vReturn)
939 bUno = ( oObjDesc.iVarType = V_UNOOBJECT )
940 End If
941 If bUno Then
943 Set vReturnArray(0) = vReturn
944 Else
947 If bDict Then
948 vReturnArray(0) = vReturn.ConvertToPropertyValues()
949 Else
950 vReturnArray(0) = _SF_._AddToPythonSTorage(vReturn)
951 End If
952 End If
953 vReturnArray(1) = V_OBJECT
954 Select Case True
955 Case bUno : vReturnArray(2) = objUNO
956 Case bDict : vReturnArray(2) = objDICT
957 Case bBasicClass : vReturnArray(2) = objCLASS
958 Case Else : vReturnArray(2) = objMODULE
959 End Select
960 If Not bUno Then
961 vReturnArray(3) = vReturn.ObjectType
962 vReturnArray(4) = vReturn.ServiceName
964 If vReturn.ObjectType <> "SF_CalcReference" And Not bDict Then ' Calc references are implemented as a Type ... End Type data structure
965 If SF_Array.Contains(vReturn.Properties(), "Name", SortOrder := "ASC") Then vReturnArray(5) = vReturn.Name
966 End If
967 End If
968 Else ' Scalar or Nothing
970 If VarType(vReturn) = V_DATE Then vReturnArray(0) = CDateToUnoDateTime(vReturn) Else vReturnArray(0) = vReturn
971 vReturnArray(1) = VarType(vReturn)
972 End If
974 ' Tests with non-modal dialogs and sleeping (time.sleep) Python processes show
975 ' a more fluid reactivity when next statement is present, at a minimal cost.
976 Wait 0
978 _PythonDispatcher = vReturnArray
980 Finally:
981 _SF_.TriggeredByPython = False ' Reset normal state
982 Exit Function
983 Catch:
984 GoTo Finally
985 End Function ' ScriptForge.SF_PythonHelper._PythonDispatcher
987 REM -----------------------------------------------------------------------------
988 Private Function _Repr() As String
989 ''' Convert the Basic instance to a readable string, typically for debugging purposes (DebugPrint ...)
990 ''' Args:
991 ''' Return:
996 End Function ' ScriptForge.SF_PythonHelper._Repr
998 REM ================================================= END OF SCRIPTFORGE.SF_PythonHelper
999 </script:module>