| blob | ad0566ddfe9f15852d9fcfdb23265664f4cb8887 |
3 <script:module xmlns:script="http://openoffice.org/2000/script" script:name="SF_Exception" 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 ''' Exception (aka SF_Exception)
13 ''' =========
14 ''' Generic singleton class for Basic code debugging and error handling
15 '''
16 ''' Errors may be generated by
17 ''' the Basic run-time error detection
20 ''' an error detection implemented
23 '''
24 ''' When a run-time error occurs, the properties of the Exception object are filled
25 ''' with information that uniquely identifies the error and information that can be used to handle it
26 ''' The SF_Exception object is in this context similar to the VBA Err object
27 ''' See https://docs.microsoft.com/en-us/office/vba/language/reference/user-interface-help/err-object
28 ''' The Number property identifies the error: it can be a numeric value or a string
30 '''
31 ''' The "console" logs events, actual variable values, errors, ... It is an easy mean
32 ''' to debug Basic programs especially when the IDE is not usable, f.i. in Calc user defined functions
33 ''' or during control events processing
35 '''
36 ''' The usual behaviour of the application when an error occurs is:
38 ''' 2, Inform the user about the error with either a standard or a customized message
40 '''
41 ''' Detailed user documentation:
42 ''' https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_exception.html?DbPAR=BASIC
43 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
45 REM ================================================================== EXCEPTIONS
47 ' SF_Utils
53 ' SF_Array
61 ' SF_Dictionary
66 ' SF_FileSystem
77 ' SF_Services
81 ' SF_Session
88 ' SF_TextStream
93 ' SF_UI
99 ' SF_Document
106 ' SF_Calc
113 ' SF_Chart
116 ' SF_Form
124 ' SF_Writer
127 ' SF_Dialog
135 ' SF_Database
143 ' Python
146 ' SF_UnitTest
150 REM ============================================================= PRIVATE MEMBERS
152 ' User defined errors
153 Private _Number As Variant ' Error number/code (Integer or String)
154 Private _Source As Variant ' Where the error occurred: a module, a Sub/Function, ...
155 Private _Description As String ' The error message
157 ' System run-time errors
158 Private _SysNumber As Long ' Alias of Err
159 Private _SysSource As Long ' Alias of Erl
160 Private _SysDescription As String ' Alias of Error$
162 REM ============================================================ MODULE CONSTANTS
167 REM ===================================================== CONSTRUCTOR/DESTRUCTOR
169 REM -----------------------------------------------------------------------------
170 Public Function Dispose() As Variant
171 Set Dispose = Nothing
172 End Function ' ScriptForge.SF_Exception Explicit destructor
174 REM ================================================================== PROPERTIES
176 REM -----------------------------------------------------------------------------
177 Property Get Description() As Variant
178 ''' Returns the description of the last error that has occurred
179 ''' Example:
180 ''' myException.Description
182 End Property ' ScriptForge.SF_Exception.Description (get)
184 REM -----------------------------------------------------------------------------
185 Property Let Description(ByVal pvDescription As Variant)
186 ''' Set the description of the last error that has occurred
187 ''' Example:
190 End Property ' ScriptForge.SF_Exception.Description (let)
192 REM -----------------------------------------------------------------------------
193 Property Get Number() As Variant
194 ''' Returns the code of the last error that has occurred
195 ''' Example:
196 ''' myException.Number
198 End Property ' ScriptForge.SF_Exception.Number (get)
200 REM -----------------------------------------------------------------------------
201 Property Let Number(ByVal pvNumber As Variant)
202 ''' Set the code of the last error that has occurred
203 ''' Example:
206 End Property ' ScriptForge.SF_Exception.Number (let)
208 REM -----------------------------------------------------------------------------
209 Property Get Source() As Variant
210 ''' Returns the location of the last error that has occurred
211 ''' Example:
212 ''' myException.Source
214 End Property ' ScriptForge.SF_Exception.Source (get)
216 REM -----------------------------------------------------------------------------
217 Property Let Source(ByVal pvSource As Variant)
218 ''' Set the location of the last error that has occurred
219 ''' Example:
222 End Property ' ScriptForge.SF_Exception.Source (let)
224 REM -----------------------------------------------------------------------------
225 Property Get ObjectType As String
226 ''' Only to enable object representation
228 End Property ' ScriptForge.SF_String.ObjectType
230 REM -----------------------------------------------------------------------------
231 Property Get ServiceName As String
232 ''' Internal use
234 End Property ' ScriptForge.SF_Exception.ServiceName
236 REM ===================================================================== METHODS
238 REM -----------------------------------------------------------------------------
239 Public Sub Clear()
240 ''' Reset the current error status and clear the SF_Exception object
241 ''' Args:
242 ''' Examples:
243 ''' On Local Error GoTo Catch
244 ''' ' ...
245 ''' Catch:
249 Const cstSubArgs = ""
251 Check:
253 Try:
254 With SF_Exception
255 ._Number = Empty
256 ._Source = Empty
257 ._Description = ""
258 ._SysNumber = 0
259 ._SysSource = 0
260 ._SysDescription = ""
261 End With
263 Finally:
264 On Error GoTo 0
265 Exit Sub
266 Catch:
267 GoTo Finally
268 End Sub ' ScriptForge.SF_Exception.Clear
270 REM -----------------------------------------------------------------------------
271 Public Sub Console(Optional ByVal Modal As Variant, _
272 Optional ByRef _Context As Variant _
273 )
274 ''' Display the console messages in a modal or non-modal dialog
275 ''' If the dialog is already active, when non-modal, it is brought to front
276 ''' Args:
277 ''' Modal: Boolean. Default = True
278 ''' _Context: From Python, the XComponentXontext (FOR INTERNAL USE ONLY)
279 ''' Example:
280 ''' SF_Exception.Console()
282 Dim bConsoleActive As Boolean ' When True, dialog is active
283 Dim oModalBtn As Object ' Modal close button
284 Dim oNonModalBtn As Object ' Non modal close button
288 ' Save Err, Erl, .. values before any On Error ... statement
289 SF_Exception._CaptureSystemError()
290 If SF_Utils._ErrorHandling() Then On Local Error GoTo Finally ' Never interrupt processing
292 Check:
293 If IsMissing(Modal) Or IsEmpty(Modal) Then Modal = True
294 If IsMissing(_Context) Or IsEmpty(_Context) Then _Context = Nothing
295 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
297 End If
299 Try:
300 With _SF_
301 bConsoleActive = False
302 If Not IsNull(.ConsoleDialog) Then bConsoleActive = .ConsoleDialog._IsStillAlive(False) ' False to not raise an error
303 If bConsoleActive And Modal = False Then
304 ' Bring to front
305 .ConsoleDialog.Activate()
306 Else
307 ' Initialize dialog and fill with actual data
308 ' The dual modes (modal and non-modal) require to have 2 close buttons o/w only 1 is visible
309 ' - a usual OK button
310 ' - a Default button triggering the Close action
311 Set .ConsoleDialog = CreateScriptService("SFDialogs.Dialog", "GlobalScope", "ScriptForge", "dlgConsole", _Context)
312 ' Setup labels and visibility
315 oModalBtn.Visible = Modal
316 oNonModalBtn.Visible = CBool(Not Modal)
317 ' Load console lines
318 _ConsoleRefresh()
319 .ConsoleDialog.Execute(Modal)
320 ' Terminate the modal dialog
321 If Modal Then
322 Set .ConsoleControl = .ConsoleControl.Dispose()
323 Set .ConsoleDialog = .ConsoleDialog.Dispose()
324 End If
325 End If
326 End With
328 Finally:
329 SF_Utils._ExitFunction(cstThisSub)
330 Exit Sub
331 End Sub ' ScriptForge.SF_Exception.Console
333 REM -----------------------------------------------------------------------------
334 Public Sub ConsoleClear(Optional ByVal Keep)
335 ''' Clear the console keeping an optional number of recent messages
336 ''' Args:
337 ''' Keep: the number of messages to keep
338 ''' If Keep is bigger than the number of messages stored in the console,
339 ''' the console is not cleared
340 ''' Example:
343 Dim lConsole As Long ' UBound of ConsoleLines
347 ' Save Err, Erl, .. values before any On Error ... statement
348 SF_Exception._CaptureSystemError()
349 If SF_Utils._ErrorHandling() Then On Local Error GoTo Finally ' Never interrupt processing
351 Check:
352 If IsMissing(Keep) Or IsEmpty(Keep) Then Keep = 0
353 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
355 End If
357 Try:
358 With _SF_
360 .ConsoleLines = Array()
361 Else
362 lConsole = UBound(.ConsoleLines)
363 If Keep < lConsole + 1 Then .ConsoleLines = SF_Array.Slice(.ConsoleLines, lConsole - Keep + 1)
364 End If
365 End With
367 ' If active, the console dialog needs to be refreshed
368 _ConsoleRefresh()
370 Finally:
371 SF_Utils._ExitFunction(cstThisSub)
372 Exit Sub
373 End Sub ' ScriptForge.SF_Exception.ConsoleClear
375 REM -----------------------------------------------------------------------------
376 Public Function ConsoleToFile(Optional ByVal FileName As Variant) As Boolean
377 ''' Export the content of the console to a text file
378 ''' If the file exists and the console is not empty, it is overwritten without warning
379 ''' Args:
380 ''' FileName: the complete file name to export to. If it exists, is overwritten without warning
381 ''' Returns:
382 ''' True if the file could be created
383 ''' Examples:
386 Dim bExport As Boolean ' Return value
387 Dim oFile As Object ' Output file handler
388 Dim sLine As String ' A single line
392 ' Save Err, Erl, .. values before any On Error ... statement
393 SF_Exception._CaptureSystemError()
394 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
395 bExport = False
397 Check:
398 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
400 End If
402 Try:
405 Set oFile = SF_FileSystem.CreateTextFile(FileName, Overwrite := True)
406 If Not IsNull(oFile) Then
407 With oFile
408 For Each sLine In _SF_.ConsoleLines
409 .WriteLine(sLine)
410 Next sLine
411 .CloseFile()
412 End With
413 End If
414 bExport = True
415 End If
417 Finally:
418 If Not IsNull(oFile) Then Set oFile = oFile.Dispose()
419 ConsoleToFile = bExport
420 SF_Utils._ExitFunction(cstThisSub)
421 Exit Function
422 Catch:
423 GoTo Finally
424 End Function ' ScriptForge.SF_Exception.ConsoleToFile
426 REM -----------------------------------------------------------------------------
427 Public Sub DebugDisplay(ParamArray pvArgs() As Variant)
428 ''' Display the list of arguments in a readable form in a message box
429 ''' Arguments are separated by a LINEFEED character
431 ''' Args:
432 ''' Any number of arguments of any type
433 ''' Examples:
434 ''' SF_Exception.DebugDisplay(a, Array(1, 2, 3), , "line1" & Chr(10) & "Line2", DateSerial(2020, 04, 09))
436 Dim sOutputMsg As String ' Line to display
437 Dim sOutputCon As String ' Line to write in console
438 Dim sArgMsg As String ' Single argument
439 Dim sArgCon As String ' Single argument
440 Dim i As Integer
441 Const cstTab = 4
442 Const cstMaxLength = 1024
446 ' Save Err, Erl, .. values before any On Error ... statement
447 SF_Exception._CaptureSystemError()
448 If SF_Utils._ErrorHandling() Then On Local Error Goto Finally ' Never interrupt processing
449 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
450 Try:
451 ' Build new console line
453 For i = 0 To UBound(pvArgs)
454 If IsError(pvArgs(i)) Then pvArgs(i) = ""
455 sArgMsg = Iif(i = 0, "", SF_String.sfNEWLINE) & SF_Utils._Repr(pvArgs(i), cstMaxLength) 'Do not use SF_String.Represent()
456 sArgCon = Iif(i = 0, "", SF_String.sfTAB) & SF_Utils._Repr(pvArgs(i), cstMaxLength)
457 sOutputMsg = sOutputMsg & sArgMsg
458 sOutputCon = sOutputCon & sArgCon
459 Next i
461 ' Add to actual console
462 _SF_._AddToConsole(SF_String.ExpandTabs(sOutputCon, cstTab))
463 ' Display the message
466 Finally:
467 SF_Utils._ExitFunction(cstThisSub)
468 Exit Sub
469 End Sub ' ScriptForge.SF_Exception.DebugDisplay
471 REM -----------------------------------------------------------------------------
472 Public Sub DebugPrint(ParamArray pvArgs() As Variant)
473 ''' Print the list of arguments in a readable form in the console
474 ''' Arguments are separated by a TAB character (simulated by spaces)
476 ''' Args:
477 ''' Any number of arguments of any type
478 ''' Examples:
479 ''' SF_Exception.DebugPrint(a, Array(1, 2, 3), , "line1" & Chr(10) & "Line2", DateSerial(2020, 04, 09))
481 Dim sOutput As String ' Line to write in console
482 Dim sArg As String ' Single argument
483 Dim i As Integer
484 Const cstTab = 4
485 Const cstMaxLength = 1024
489 ' Save Err, Erl, .. values before any On Error ... statement
490 SF_Exception._CaptureSystemError()
491 If SF_Utils._ErrorHandling() Then On Local Error Goto Finally ' Never interrupt processing
492 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
493 Try:
494 ' Build new console line
495 sOutput = ""
496 For i = 0 To UBound(pvArgs)
497 If IsError(pvArgs(i)) Then pvArgs(i) = ""
498 sArg = Iif(i = 0, "", SF_String.sfTAB) & SF_Utils._Repr(pvArgs(i), cstMaxLength) 'Do not use SF_String.Represent()
499 sOutput = sOutput & sArg
500 Next i
502 ' Add to actual console
503 _SF_._AddToConsole(SF_String.ExpandTabs(sOutput, cstTab))
505 Finally:
506 SF_Utils._ExitFunction(cstThisSub)
507 Exit Sub
508 End Sub ' ScriptForge.SF_Exception.DebugPrint
510 REM -----------------------------------------------------------------------------
511 Public Function GetProperty(Optional ByVal PropertyName As Variant) As Variant
512 ''' Return the actual value of the given property
513 ''' Args:
514 ''' PropertyName: the name of the property as a string
515 ''' Returns:
516 ''' The actual value of the property
517 ''' If the property does not exist, returns Null
518 ''' Exceptions
519 ''' ARGUMENTERROR The property does not exist
520 ''' Examples:
524 Const cstSubArgs = ""
526 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
527 GetProperty = Null
529 Check:
530 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
531 If Not SF_Utils._Validate(PropertyName, "PropertyName", V_STRING, Properties()) Then GoTo Catch
532 End If
534 Try:
535 GetProperty = _PropertyGet(PropertyName)
537 Finally:
538 SF_Utils._ExitFunction(cstThisSub)
539 Exit Function
540 Catch:
541 GoTo Finally
542 End Function ' ScriptForge.SF_Exception.GetProperty
544 REM -----------------------------------------------------------------------------
545 Public Function Methods() As Variant
546 ''' Return the list of public methods of the Exception service as an array
548 Methods = Array( _
558 )
560 End Function ' ScriptForge.SF_Exception.Methods
562 REM -----------------------------------------------------------------------------
563 Public Function Properties() As Variant
564 ''' Return the list or properties of the Timer class as an array
566 Properties = Array( _
570 )
572 End Function ' ScriptForge.SF_Exception.Properties
574 REM -----------------------------------------------------------------------------
575 Public Sub PythonPrint(ParamArray pvArgs() As Variant)
576 ''' Display the list of arguments in a readable form in the Python console
577 ''' Arguments are separated by a TAB character (simulated by spaces)
579 ''' Args:
580 ''' Any number of arguments of any type
581 ''' Examples:
582 ''' SF_Exception.PythonPrint(a, Array(1, 2, 3), , "line1" & Chr(10) & "Line2", DateSerial(2020, 04, 09))
584 Dim sOutput As String ' Line to write in console
585 Dim sArg As String ' Single argument
586 Dim i As Integer
587 Const cstTab = 4
588 Const cstMaxLength = 1024
593 ' Save Err, Erl, .. values before any On Error ... statement
594 SF_Exception._CaptureSystemError()
595 If SF_Utils._ErrorHandling() Then On Local Error Goto Finally ' Never interrupt processing
596 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
597 Try:
598 ' Build new console line
599 sOutput = ""
600 For i = 0 To UBound(pvArgs)
601 If IsError(pvArgs(i)) Then pvArgs(i) = ""
603 sOutput = sOutput & sArg
604 Next i
606 ' Add to actual console
607 sOutput = SF_String.ExpandTabs(sOutput, cstTab)
608 _SF_._AddToConsole(sOutput)
609 ' Display the message in the Python shell console
610 With ScriptForge.SF_Session
611 .ExecutePythonScript(.SCRIPTISSHARED, _SF_.PythonHelper & cstPyHelper, sOutput)
612 End With
614 Finally:
615 SF_Utils._ExitFunction(cstThisSub)
616 Exit Sub
617 End Sub ' ScriptForge.SF_Exception.PythonPrint
619 REM -----------------------------------------------------------------------------
620 Public Sub Raise(Optional ByVal Number As Variant _
621 , Optional ByVal Source As Variant _
622 , Optional ByVal Description As Variant _
623 )
624 ''' Generate a run-time error. An error message is displayed to the user and logged
625 ''' in the console. The execution is STOPPED
626 ''' Args:
627 ''' Number: the error number, may be numeric or string
628 ''' If numeric and <= 2000, it is considered a LibreOffice Basic run-time error (default = Err)
629 ''' Source: the line where the error occurred (default = Erl) or any string describing the location of the error
630 ''' Description: the error message to log in the console and to display to the user
631 ''' Examples:
632 ''' On Local Error GoTo Catch
633 ''' ' ...
634 ''' Catch:
637 ''' SF_Exception.Raise("MYAPPERROR", "myFunction", "Application error")
640 Dim sMessage As String ' Error message to log and to display
641 Dim L10N As Object ' Alias to LocalizedInterface
645 ' Save Err, Erl, .. values before any On Error ... statement
646 SF_Exception._CaptureSystemError()
647 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
649 Check:
650 If IsMissing(Number) Or IsEmpty(Number) Then Number = -1
651 If IsMissing(Source) Or IsEmpty(Source) Then Source = -1
652 If IsMissing(Description) Or IsEmpty(Description) Then Description = ""
653 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
654 If Not SF_Utils._Validate(Number, "Number", Array(V_STRING, V_NUMERIC)) Then GoTo Finally
655 If Not SF_Utils._Validate(Source, "Source", Array(V_STRING, V_NUMERIC)) Then GoTo Finally
657 End If
659 Try:
660 With SF_Exception
662 If VarType(Source) = V_STRING Then
665 .Source = Source
666 End If
669 ' Log and display
670 Set L10N = _SF_._GetLocalizedInterface()
672 .DebugPrint(sMessage)
676 , MB_OK + MB_ICONSTOP _
678 End With
680 Finally:
681 SF_Utils._ExitFunction(cstThisSub)
682 If _SF_.StopWhenError Then
683 SF_Exception.Clear()
684 _SF_._StackReset()
685 Stop
686 End If
687 Exit Sub
688 Catch:
689 GoTo Finally
690 End Sub ' ScriptForge.SF_Exception.Raise
692 REM -----------------------------------------------------------------------------
693 Public Sub RaiseAbort(Optional ByVal Source As Variant)
694 ''' Manage a run-time error that occurred inside the ScriptForge piece of software itself.
695 ''' The event is logged.
696 ''' The execution is STOPPED
697 ''' For INTERNAL USE only
698 ''' Args:
699 ''' Source: the line where the error occurred
701 Dim sLocation As String ' Common header in error messages: location of error
702 Dim vLocation As Variant ' Split array (library, module, method)
703 Dim sMessage As String ' Error message to log and to display
704 Dim L10N As Object ' Alias to LocalizedInterface
705 Const cstTabSize = 4
709 ' Save Err, Erl, .. values before any On Error ... statement
710 SF_Exception._CaptureSystemError()
711 On Local Error Resume Next
713 Check:
714 If IsMissing(Source) Or IsEmpty(Source) Then Source = ""
716 Try:
717 With SF_Exception
719 ' Prepare message header
720 Set L10N = _SF_._GetLocalizedInterface()
723 If UBound(vLocation) < 2 Then vLocation = Split("ScriptForge." & _SF_.MainFunction, ".")
724 sLocation = L10N.GetText("VALIDATESOURCE", vLocation(0), vLocation(1), vLocation(2)) & "\n\n\n"
725 Else
726 sLocation = ""
727 End If
729 ' Log and display
731 .DebugPrint(sMessage)
732 If _SF_.DisplayEnabled Then
733 sMessage = sLocation _
735 & L10N.GetText("ERRORLOCATION", Source & "/" & .Source) & SF_String.sfNewLine & .Description _
736 & "\n" & "\n" & "\n" & L10N.GetText("STOPEXECUTION")
737 MsgBox SF_String.ExpandTabs(SF_String.Unescape(sMessage), cstTabSize) _
738 , MB_OK + MB_ICONSTOP _
740 End If
742 .Clear()
743 End With
745 Finally:
746 _SF_._StackReset()
747 If _SF_.StopWhenError Then Stop
748 Exit Sub
749 Catch:
750 GoTo Finally
751 End Sub ' ScriptForge.SF_Exception.RaiseAbort
753 REM -----------------------------------------------------------------------------
754 Public Sub RaiseFatal(Optional ByVal ErrorCode As Variant _
755 , ParamArray pvArgs _
756 )
757 ''' Generate a run-time error caused by an anomaly in a user script detected by ScriptForge
758 ''' The message is logged in the console. The execution is STOPPED
759 ''' For INTERNAL USE only
760 ''' Args:
761 ''' ErrorCode: as a string, the unique identifier of the error
762 ''' pvArgs: the arguments to insert in the error message
764 Dim sLocation As String ' Common header in error messages: location of error
765 Dim sService As String ' Service name having detected the error
766 Dim sMethod As String ' Method name having detected the error
767 Dim vLocation As Variant ' Split array (library, module, method)
768 Dim sMessage As String ' Message to log and display
769 Dim L10N As Object ' Alias of LocalizedInterface
770 Dim sAlt As String ' Alternative error messages
771 Dim iButtons As Integer ' MB_OK or MB_YESNO
772 Dim iMsgBox As Integer ' Return value of the message box
774 Const cstTabSize = 4
779 ' Save Err, Erl, .. values before any On Error ... statement
780 SF_Exception._CaptureSystemError()
781 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
783 Check:
784 If IsMissing(ErrorCode) Or IsEmpty(ErrorCode) Then ErrorCode = ""
785 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
787 End If
789 Try:
790 Set L10N = _SF_._GetLocalizedInterface()
791 ' Location header common to all error messages
794 If UBound(vLocation) < 2 Then vLocation = Split("ScriptForge." & _SF_.MainFunction, ".")
795 sService = vLocation(1)
796 sMethod = vLocation(2)
798 & "\n" & L10N.GetText("VALIDATEARGS", _RightCaseArgs(_SF_.MainFunctionArgs))
799 Else
800 sService = ""
801 sMethod = ""
802 sLocation = ""
803 End If
805 With L10N
806 Select Case UCase(ErrorCode)
807 Case MISSINGARGERROR ' SF_Utils._Validate(Name)
809 sMessage = sLocation _
810 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
811 & "\n" & "\n" & .GetText("VALIDATEMISSING", pvArgs(0))
812 Case ARGUMENTERROR ' SF_Utils._Validate(Value, Name, Types, Values, CaseSensitive, Class)
814 sMessage = sLocation _
815 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(1)) _
817 If Len(pvArgs(2)) > 0 Then sMessage = sMessage & "\n" & .GetText("VALIDATETYPES", pvArgs(1), pvArgs(2))
818 If Len(pvArgs(3)) > 0 Then sMessage = sMessage & "\n" & .GetText("VALIDATEVALUES", pvArgs(1), pvArgs(3))
819 If Len(pvArgs(5)) > 0 Then sMessage = sMessage & "\n" & .GetText("VALIDATECLASS", pvArgs(1), pvArgs(5))
820 sMessage = sMessage & "\n" & "\n" & .GetText("VALIDATEACTUAL", pvArgs(1), pvArgs(0))
821 Case ARRAYERROR ' SF_Utils._ValidateArray(Value, Name, Dimensions, Types, NotNull)
823 sMessage = sLocation _
824 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(1)) _
827 If pvArgs(2) > 0 Then sMessage = sMessage & "\n" & .GetText("VALIDATEDIMS", pvArgs(1), pvArgs(2))
828 If Len(pvArgs(3)) > 0 Then sMessage = sMessage & "\n" & .GetText("VALIDATEALLTYPES", pvArgs(1), pvArgs(3))
829 If pvArgs(4) Then sMessage = sMessage & "\n" & .GetText("VALIDATENOTNULL", pvArgs(1))
830 sMessage = sMessage & "\n" & "\n" & .GetText("VALIDATEACTUAL", pvArgs(1), pvArgs(0))
831 Case FILEERROR ' SF_Utils._ValidateFile(Value, Name, WildCards)
833 sMessage = sLocation _
834 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(1)) _
839 If pvArgs(2) Then sMessage = sMessage & "\n" & .GetText("VALIDATEWILDCARD", pvArgs(1))
840 sMessage = sMessage & "\n" & "\n" & .GetText("VALIDATEACTUAL", pvArgs(1), pvArgs(0))
841 Case ARRAYSEQUENCEERROR ' SF_Array.RangeInit(From, UpTo, ByStep)
842 sMessage = sLocation _
843 & "\n" & "\n" & "\n" & .GetText("ARRAYSEQUENCE", pvArgs(0), pvArgs(1), pvArgs(2))
844 Case ARRAYINSERTERROR ' SF_Array.AppendColumn/Row/PrependColumn/Row(VectorName, Array_2D, Vector)
845 sMessage = sLocation _
846 & "\n" & "\n" & "\n" & .GetText("ARRAYINSERT", pvArgs(0), pvArgs(1), pvArgs(2))
847 Case ARRAYINDEX1ERROR ' SF_Array.ExtractColumn/Row(IndexName, Array_2D, Index)
848 sMessage = sLocation _
849 & "\n" & "\n" & "\n" & .GetText("ARRAYINDEX1", pvArgs(0), pvArgs(1), pvArgs(2))
850 Case ARRAYINDEX2ERROR ' SF_Array.Slice(From, UpTo)
851 sMessage = sLocation _
852 & "\n" & "\n" & "\n" & .GetText("ARRAYINDEX2", pvArgs(0), pvArgs(1), pvArgs(2))
853 Case CSVPARSINGERROR ' SF_Array.ImportFromCSVFile(FileName, LineNumber, Line)
854 sMessage = sLocation _
855 & "\n" & "\n" & "\n" & .GetText("CSVPARSING", pvArgs(0), pvArgs(1), pvArgs(2))
857 sMessage = sLocation _
858 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
859 & "\n" & "\n" & .GetText("DUPLICATEKEY", pvArgs(0), pvArgs(1))
861 sMessage = sLocation _
862 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
863 & "\n" & "\n" & .GetText("UNKNOWNKEY", pvArgs(0), pvArgs(1))
864 Case INVALIDKEYERROR ' SF_Dictionary.Add/ReplaceKey(Key)
865 sMessage = sLocation _
866 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
868 Case UNKNOWNFILEERROR ' SF_FileSystem.CopyFile/MoveFile/DeleteFile/CreateScriptService("L10N")(ArgName, Filename)
870 sMessage = sLocation _
871 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
872 & "\n" & "\n" & .GetText("UNKNOWNFILE", pvArgs(0), pvArgs(1))
873 Case UNKNOWNFOLDERERROR ' SF_FileSystem.CopyFolder/MoveFolder/DeleteFolder/Files/SubFolders(ArgName, Filename)
875 sMessage = sLocation _
876 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
877 & "\n" & "\n" & .GetText("UNKNOWNFOLDER", pvArgs(0), pvArgs(1))
878 Case NOTAFILEERROR ' SF_FileSystem.CopyFile/MoveFile/DeleteFile(ArgName, Filename)
880 sMessage = sLocation _
881 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
882 & "\n" & "\n" & .GetText("NOTAFILE", pvArgs(0), pvArgs(1))
883 Case NOTAFOLDERERROR ' SF_FileSystem.CopyFolder/MoveFolder/DeleteFolder/Files/SubFolders(ArgName, Filename)
885 sMessage = sLocation _
886 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
887 & "\n" & "\n" & .GetText("NOTAFOLDER", pvArgs(0), pvArgs(1))
888 Case OVERWRITEERROR ' SF_FileSystem.Copy+Move/File+Folder/CreateTextFile/OpenTextFile(ArgName, Filename)
890 sMessage = sLocation _
891 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
892 & "\n" & "\n" & .GetText("OVERWRITE", pvArgs(0), pvArgs(1))
893 Case READONLYERROR ' SF_FileSystem.Copy+Move+Delete/File+Folder(ArgName, Filename)
895 sMessage = sLocation _
896 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
897 & "\n" & "\n" & .GetText("READONLY", pvArgs(0), pvArgs(1))
898 Case NOFILEMATCHERROR ' SF_FileSystem.Copy+Move+Delete/File+Folder(ArgName, Filename)
900 sMessage = sLocation _
901 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
902 & "\n" & "\n" & .GetText("NOFILEMATCH", pvArgs(0), pvArgs(1))
903 Case FOLDERCREATIONERROR ' SF_FileSystem.CreateFolder(ArgName, Filename)
905 sMessage = sLocation _
906 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
907 & "\n" & "\n" & .GetText("FOLDERCREATION", pvArgs(0), pvArgs(1))
908 Case FILESYSTEMERROR ' SF_FileSystem.---(ArgName, MethodName, ArgValue)
910 sMessage = sLocation _
911 & "\n" & "\n" & .GetText("FILESYSTEM", pvArgs(0), pvArgs(1), pvArgs(2))
912 Case UNKNOWNSERVICEERROR ' SF_Services.CreateScriptService(ArgName, Value, Library, Service)
914 sMessage = sLocation _
915 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
916 & "\n" & "\n" & .GetText("UNKNOWNSERVICE", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
917 Case SERVICESNOTLOADEDERROR ' SF_Services.CreateScriptService(ArgName, Value, Library)
919 sMessage = sLocation _
920 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
921 & "\n" & "\n" & .GetText("SERVICESNOTLOADED", pvArgs(0), pvArgs(1), pvArgs(2))
922 Case CALCFUNCERROR ' SF_Session.ExecuteCalcFunction(CalcFunction)
923 sMessage = sLocation _
924 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", _RightCase("CalcFunction")) _
926 Case NOSCRIPTERROR ' SF_Session._GetScript(Language, "Scope", Scope, "Script", Script)
928 sMessage = sLocation _
929 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", _RightCase("Script")) _
930 & "\n" & "\n" & .GetText("NOSCRIPT", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3), pvArgs(4))
933 sMessage = sLocation _
934 & "\n" & "\n" & .GetText("SCRIPTEXEC", pvArgs(0), pvArgs(1), pvArgs(2))
935 Case WRONGEMAILERROR ' SF_Session.SendMail(Arg, Email)
937 sMessage = sLocation _
938 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
940 Case SENDMAILERROR ' SF_Session.SendMail()
941 sMessage = sLocation _
943 Case FILENOTOPENERROR ' SF_TextStream._IsFileOpen(FileName)
944 sMessage = sLocation _
946 Case FILEOPENMODEERROR ' SF_TextStream._IsFileOpen(FileName)
947 sMessage = sLocation _
948 & "\n" & "\n" & .GetText("FILEOPENMODE", pvArgs(0), pvArgs(1))
949 Case ENDOFFILEERROR ' SF_TextStream.ReadLine/ReadAll/SkipLine(FileName)
950 sMessage = sLocation _
952 Case DOCUMENTERROR ' SF_UI.GetDocument(ArgName, WindowName)
954 sMessage = sLocation _
955 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
956 & "\n" & "\n" & .GetText("DOCUMENT", pvArgs(0), pvArgs(1))
957 Case DOCUMENTCREATIONERROR ' SF_UI.Create(Arg1Name, DocumentType, Arg2Name, TemplateFile)
959 sMessage = sLocation _
960 & "\n" & "\n" & .GetText("DOCUMENTCREATION", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
961 Case DOCUMENTOPENERROR ' SF_UI.OpenDocument(Arg1Name, FileName, Arg2Name, Password, Arg3Name, FilterName)
962 pvArgs(0) = _RightCase(pvArgs(0)) : pvArgs(2) = _RightCase(pvArgs(2)) : pvArgs(4) = _RightCase(pvArgs(4))
963 sMessage = sLocation _
964 & "\n" & "\n" & .GetText("DOCUMENTOPEN", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3), pvArgs(4), pvArgs(5))
965 Case BASEDOCUMENTOPENERROR ' SF_UI.OpenBaseDocument(Arg1Name, FileName, Arg2Name, RegistrationName)
967 sMessage = sLocation _
968 & "\n" & "\n" & .GetText("BASEDOCUMENTOPEN", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
969 Case DOCUMENTDEADERROR ' SF_Document._IsStillAlive(FileName)
970 sMessage = sLocation _
972 Case DOCUMENTSAVEERROR ' SF_Document.Save(Arg1Name, FileName)
974 sMessage = sLocation _
975 & "\n" & "\n" & .GetText("DOCUMENTSAVE", pvArgs(0), pvArgs(1))
976 Case DOCUMENTSAVEASERROR ' SF_Document.SaveAs(Arg1Name, FileName, Arg2, Overwrite, Arg3, FilterName)
977 pvArgs(0) = _RightCase(pvArgs(0)) : pvArgs(2) = _RightCase(pvArgs(2)) : pvArgs(4) = _RightCase(pvArgs(4))
978 sMessage = sLocation _
979 & "\n" & "\n" & .GetText("DOCUMENTSAVEAS", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3), pvArgs(4), pvArgs(5))
982 sMessage = sLocation _
983 & "\n" & "\n" & .GetText("DOCUMENTREADONLY", pvArgs(0), pvArgs(1))
984 Case DBCONNECTERROR ' SF_Base.GetDatabase("User", User, "Password", Password, FileName)
986 sMessage = sLocation _
987 & "\n" & "\n" & .GetText("DBCONNECT", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3), pvArgs(4))
988 Case CALCADDRESSERROR ' SF_Calc._ParseAddress(Address, "Range"/"Sheet", Scope, Document)
990 sMessage = sLocation _
991 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
992 & "\n" & "\n" & .GetText("CALCADDRESS" & Iif(Left(pvArgs(0), 5) = "Sheet", "1", "2"), pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
993 Case DUPLICATESHEETERROR ' SF_Calc.InsertSheet(arg, SheetName, Document)
995 sMessage = sLocation _
996 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
997 & "\n" & "\n" & .GetText("DUPLICATESHEET", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
998 Case OFFSETADDRESSERROR ' SF_Calc.RangeOffset("Range", Range, "Rows", Rows, "Columns", Columns, "Height", Height, "Width", Width, "Document, Document)
999 pvArgs(0) = _RightCase(pvArgs(0)) : pvArgs(2) = _RightCase(pvArgs(2)) : pvArgs(4) = _RightCase(pvArgs(4))
1000 pvArgs(6) = _RightCase(pvArgs(6)) : pvArgs(8) = _RightCase(pvArgs(8)) : pvArgs(10) = _RightCase(pvArgs(10))
1001 sMessage = sLocation _
1002 & "\n" & "\n" & .GetText("OFFSETADDRESS", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3), pvArgs(4) _
1004 Case DUPLICATECHARTERROR ' SF_Calc.CreateChart(chart, ChartName, sheet, SheetName, Document, file)
1006 sMessage = sLocation _
1007 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
1008 & "\n" & "\n" & .GetText("DUPLICATECHART", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3), pvArgs(4), pvArgs(5))
1009 Case RANGEEXPORTERROR ' SF_Calc.ExportRangeToFile(Arg1Name, FileName, Arg2, Overwrite)
1011 sMessage = sLocation _
1012 & "\n" & "\n" & .GetText("RANGEEXPORT", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
1013 Case CHARTEXPORTERROR ' SF_Chart.ExportToFile(Arg1Name, FileName, Arg2, Overwrite)
1015 sMessage = sLocation _
1016 & "\n" & "\n" & .GetText("CHARTEXPORT", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
1017 Case FORMDEADERROR ' SF_Form._IsStillAlive(FormName, DocumentName)
1018 sMessage = sLocation _
1019 & "\n" & "\n" & .GetText("FORMDEAD", pvArgs(0), pvArgs(1))
1020 Case CALCFORMNOTFOUNDERROR ' SF_Calc.Forms(Index, SheetName, Document)
1021 sMessage = sLocation _
1022 & "\n" & "\n" & .GetText("CALCFORMNOTFOUND", pvArgs(0), pvArgs(1), pvArgs(2))
1023 Case WRITERFORMNOTFOUNDERROR ' SF_Document.Forms(Index, Document)
1024 sMessage = sLocation _
1025 & "\n" & "\n" & .GetText("WRITERFORMNOTFOUND", pvArgs(0), pvArgs(1))
1026 Case BASEFORMNOTFOUNDERROR ' SF_Base.Forms(Index, FormDocument, BaseDocument)
1027 sMessage = sLocation _
1028 & "\n" & "\n" & .GetText("BASEFORMNOTFOUND", pvArgs(0), pvArgs(1), pvArgs(2))
1029 Case SUBFORMNOTFOUNDERROR ' SF_Form.Subforms(Subform, Mainform)
1030 sMessage = sLocation _
1031 & "\n" & "\n" & .GetText("SUBFORMNOTFOUND", pvArgs(0), pvArgs(1))
1032 Case FORMCONTROLTYPEERROR ' SF_FormControl._SetProperty(ControlName, FormName, ControlType, Property)
1033 sMessage = sLocation _
1034 & "\n" & "\n" & .GetText("FORMCONTROLTYPE", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
1035 Case WRITERRANGEERROR ' SF_Writer._ParseRange(TextRange, "TextRange", Scope, Document)
1037 sMessage = sLocation _
1038 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
1039 & "\n" & "\n" & .GetText("WRITERRANGE", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
1040 Case DIALOGNOTFOUNDERROR ' SF_Dialog._NewDialog(Service, DialogName, WindowName)
1041 pvArgs(0) = _RightCase(pvArgs(0)) : pvArgs(2) = _RightCase(pvArgs(2)) : pvArgs(4) = _RightCase(pvArgs(4))
1043 sMessage = sLocation _
1044 & "\n" & "\n" & .GetText("DIALOGNOTFOUND", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3), pvArgs(4) _
1046 Case DIALOGDEADERROR ' SF_Dialog._IsStillAlive(DialogName)
1047 sMessage = sLocation _
1049 Case CONTROLTYPEERROR ' SF_DialogControl._SetProperty(ControlName, DialogName, ControlType, Property)
1050 sMessage = sLocation _
1051 & "\n" & "\n" & .GetText("CONTROLTYPE", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
1052 Case TEXTFIELDERROR ' SF_DialogControl.WriteLine(ControlName, DialogName)
1053 sMessage = sLocation _
1054 & "\n" & "\n" & .GetText("TEXTFIELD", pvArgs(0), pvArgs(1))
1055 Case PAGEMANAGERERROR ' SF_Dialog.SetPageManager(PilotsList, TabsList, WizardsList)
1056 sMessage = sLocation _
1057 & "\n" & "\n" & .GetText("PAGEMANAGER", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3), pvArgs(4), pvArgs(5))
1058 Case DUPLICATECONTROLERROR ' SF_Dialog.CreateControl(ControlName, DialogName)
1060 sMessage = sLocation _
1061 & "\n" & "\n" & "\n" & .GetText("VALIDATEERROR", pvArgs(0)) _
1062 & "\n" & "\n" & .GetText("DUPLICATECONTROL", pvArgs(0), pvArgs(1), pvArgs(2))
1063 Case DBREADONLYERROR ' SF_Database.RunSql(), SF_Dataset.Delete(), Insert(), Update()
1064 sMessage = sLocation _
1066 Case SQLSYNTAXERROR ' SF_Database._ExecuteSql(SQL)
1067 sMessage = sLocation _
1069 Case SQLSYNTAX2ERROR ' SF_Dataset.Reload/_Initialize(SQL, Filter, OrderBy)
1070 sMessage = sLocation _
1071 & "\n" & "\n" & .GetText("SQLSYNTAX2", pvArgs(0), pvArgs(1), pvArgs(2))
1072 Case NOCURRENTRECORDERROR ' SF_Dataset.Insert/Update/GetValue/Delete
1073 sMessage = sLocation _
1075 Case RECORDUPDATEERROR ' SF_Dataset.Insert/Update(FieldName, FieldValue, FieldType)
1076 sMessage = sLocation _
1077 & "\n" & "\n" & .GetText("RECORDUPDATE", pvArgs(0), pvArgs(1), pvARgs(2))
1078 Case FIELDEXPORTERROR ' SF_Dataset.ExportFieldToFile(Arg1Name, FileName, Arg2, Overwrite)
1080 sMessage = sLocation _
1081 & "\n" & "\n" & .GetText("FIELDEXPORT", pvArgs(0), pvArgs(1), pvArgs(2), pvArgs(3))
1082 Case PYTHONSHELLERROR ' SF_Exception.PythonShell (Python only)
1083 sMessage = sLocation _
1085 Case UNITTESTLIBRARYERROR ' SFUnitTests._NewUnitTest(LibraryName)
1086 sMessage = sLocation _
1087 & "\n" & "\n" & .GetText("UNITTESTLIBRARY", pvArgs(0))
1088 Case UNITTESTMETHODERROR ' SFUnitTests.SF_UnitTest(Method)
1089 sMessage = sLocation _
1090 & "\n" & "\n" & .GetText("UNITTESTMETHOD", pvArgs(0))
1091 Case Else
1092 End Select
1093 End With
1095 ' Log fatal event
1096 _SF_._AddToConsole(sMessage)
1098 ' Display fatal event, if relevant (default)
1099 If _SF_.DisplayEnabled Then
1100 If _SF_.StopWhenError Then sMessage = sMessage & "\n" & "\n" & "\n" & L10N.GetText("STOPEXECUTION")
1101 ' Do you need more help ?
1103 sMessage = sMessage & "\n" & "\n" & L10N.GetText("NEEDMOREHELP", sMethod)
1104 iButtons = MB_YESNO + MB_DEFBUTTON2
1105 Else
1106 iButtons = MB_OK
1107 End If
1108 iMsgBox = MsgBox(SF_String.ExpandTabs(SF_String.Unescape(sMessage), cstTabSize) _
1109 , iButtons + MB_ICONEXCLAMATION _
1111 )
1112 ' If more help needed ...
1113 If iMsgBox = IDYES Then _OpenHelpInBrowser(sService, sMethod)
1114 End If
1116 Finally:
1117 SF_Utils._ExitFunction(cstThisSub)
1118 _SF_._StackReset()
1119 If _SF_.StopWhenError Then Stop
1120 Exit Sub
1121 Catch:
1122 GoTo Finally
1123 End Sub ' ScriptForge.SF_Exception.RaiseFatal
1125 REM -----------------------------------------------------------------------------
1126 Public Sub RaiseWarning(Optional ByVal Number As Variant _
1127 , Optional ByVal Source As Variant _
1128 , Optional ByVal Description As Variant _
1129 )
1130 ''' Generate a run-time error. An error message is displayed to the user and logged
1131 ''' in the console. The execution is NOT STOPPED
1132 ''' Args:
1133 ''' Number: the error number, may be numeric or string
1134 ''' If numeric and <= 2000, it is considered a LibreOffice Basic run-time error (default = Err)
1135 ''' Source: the line where the error occurred (default = Erl) or any string describing the location of the error
1136 ''' Description: the error message to log in the console and to display to the user
1137 ''' Returns:
1138 ''' True if successful. Anyway, the execution continues
1139 ''' Examples:
1140 ''' On Local Error GoTo Catch
1141 ''' ' ...
1142 ''' Catch:
1145 ''' SF_Exception.RaiseWarning("MYAPPERROR", "myFunction", "Application error")
1146 ''' SF_Exception.RaiseWarning(,, "To divide by zero is not a good idea !")
1148 Dim bStop As Boolean ' Alias for stop switch
1152 ' Save Err, Erl, .. values before any On Error ... statement
1153 SF_Exception._CaptureSystemError()
1154 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
1156 Check:
1157 If IsMissing(Number) Or IsEmpty(Number) Then Number = -1
1158 If IsMissing(Source) Or IsEmpty(Source) Then Source = -1
1159 If IsMissing(Description) Or IsEmpty(Description) Then Description = ""
1160 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
1161 If Not SF_Utils._Validate(Number, "Number", Array(V_STRING, V_NUMERIC, V_EMPTY)) Then GoTo Finally
1162 If Not SF_Utils._Validate(Source, "Source", Array(V_STRING, V_NUMERIC, V_EMPTY)) Then GoTo Finally
1164 End If
1166 Try:
1167 bStop = _SF_.StopWhenError ' Store current value to reset it before leaving the Sub
1168 _SF_.StopWhenError = False
1169 SF_Exception.Raise(Number, Source, Description)
1171 Finally:
1172 SF_Utils._ExitFunction(cstThisSub)
1173 _SF_.StopWhenError = bStop
1174 Exit Sub
1175 Catch:
1176 GoTo Finally
1177 End Sub ' ScriptForge.SF_Exception.RaiseWarning
1179 REM -----------------------------------------------------------------------------
1180 Public Function SetProperty(Optional ByVal PropertyName As Variant _
1181 , Optional ByRef Value As Variant _
1182 ) As Boolean
1183 ''' Set a new value to the given property
1184 ''' Args:
1185 ''' PropertyName: the name of the property as a string
1186 ''' Value: its new value
1187 ''' Exceptions
1188 ''' ARGUMENTERROR The property does not exist
1193 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
1194 SetProperty = False
1196 Check:
1197 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
1198 If Not SF_Utils._Validate(PropertyName, "PropertyName", V_STRING, Properties()) Then GoTo Catch
1199 End If
1201 Try:
1202 SetProperty = _PropertySet(PropertyName, Value)
1204 Finally:
1205 SF_Utils._ExitFunction(cstThisSub)
1206 Exit Function
1207 Catch:
1208 GoTo Finally
1209 End Function ' ScriptForge.SF_Exception.SetProperty
1211 REM =========================================================== PRIVATE FUNCTIONS
1213 REM -----------------------------------------------------------------------------
1214 Private Sub _CaptureSystemError()
1215 ''' Store system error status in system error properties
1216 ''' Called at each invocation of an error management property or method
1217 ''' Reset by SF_Exception.Clear()
1220 _SysNumber = Err
1221 _SysSource = Erl
1222 _SysDescription = Error$
1223 End If
1225 End Sub ' ScriptForge.SF_Exception._CaptureSystemError
1227 REM -----------------------------------------------------------------------------
1228 Public Sub _CloseConsole(Optional ByRef poEvent As Object)
1229 ''' Close the console when opened in non-modal mode
1230 ''' Triggered by the CloseNonModalButton from the dlgConsole dialog
1232 On Local Error GoTo Finally
1234 Try:
1235 With _SF_
1236 If Not IsNull(.ConsoleDialog) Then
1237 If .ConsoleDialog._IsStillAlive(False) Then ' False to not raise an error
1238 Set .ConsoleControl = .ConsoleControl.Dispose()
1239 Set .ConsoleDialog = .ConsoleDialog.Dispose()
1240 End If
1241 End If
1242 End With
1244 Finally:
1245 Exit Sub
1246 End Sub ' ScriptForge.SF_Exception._CloseConsole
1248 REM -----------------------------------------------------------------------------
1249 Private Sub _ConsoleRefresh()
1250 ''' Reload the content of the console in the dialog
1251 ''' Needed when console first loaded or when totally or partially cleared
1253 With _SF_
1254 ' Do nothing if console inactive
1255 If IsNull(.ConsoleDialog) Then GoTo Finally
1256 If Not .ConsoleDialog._IsStillAlive(False) Then ' False to not generate an error when dead
1257 Set .ConsoleControl = .ConsoleControl.Dispose()
1258 Set .ConsoleDialog = Nothing
1259 GoTo Finally
1260 End If
1261 ' Store the relevant text in the control
1262 If IsNull(.ConsoleControl) Then Set .ConsoleControl = .ConsoleDialog.Controls(CONSOLENAME)
1263 .ConsoleControl.Value = ""
1264 If UBound(.ConsoleLines) >= 0 Then .ConsoleControl.WriteLine(Join(.ConsoleLines, SF_String.sfNEWLINE))
1265 End With
1267 Finally:
1268 Exit Sub
1269 End Sub ' ScriptForge.SF_Exception._ConsoleRefresh
1271 REM -----------------------------------------------------------------------------
1272 Private Sub _OpenHelpInBrowser(ByVal psService As String, ByVal psMethod As String)
1273 ''' Open the help page and help anchor related to the given ScriptForge service and method
1275 Dim sUrl As String ' URL to open
1276 Const cstURL = "https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_%1.html?&DbPAR=BASIC#%2"
1278 On Local Error GoTo Finally ' No reason to risk abort here
1279 Try:
1280 sUrl = SF_String.ReplaceStr(cstURL, Array("%1", "%2"), Array(LCase(psService), psMethod))
1281 SF_Session.OpenUrlInBrowser(sUrl)
1283 Finally:
1284 Exit Sub
1285 End Sub ' ScriptForge.SF_Exception._OpenHelpInBrowser
1287 REM -----------------------------------------------------------------------------
1288 Private Function _PropertyGet(Optional ByVal psProperty As String) As Variant
1289 ''' Return the value of the named property
1290 ''' Args:
1291 ''' psProperty: the name of the property
1293 Dim cstThisSub As String
1294 Const cstSubArgs = ""
1298 SF_Exception._CaptureSystemError()
1300 Select Case psProperty
1302 If _Description = "" Then _PropertyGet = _SysDescription Else _PropertyGet = _Description
1304 If IsEmpty(_Number) Then _PropertyGet = _SysNumber Else _PropertyGet = _Number
1306 If IsEmpty(_Source) Then _PropertyGet = _SysSource Else _PropertyGet = _Source
1307 Case Else
1308 _PropertyGet = Null
1309 End Select
1311 Finally:
1312 Exit Function
1313 End Function ' ScriptForge.SF_Exception._PropertyGet
1315 REM -----------------------------------------------------------------------------
1316 Private Function _PropertySet(Optional ByVal psProperty As String _
1317 , Optional ByVal pvValue As Variant _
1318 ) As Boolean
1319 ''' Set a new value to the named property
1320 ''' Applicable only to user defined errors
1321 ''' Args:
1322 ''' psProperty: the name of the property
1323 ''' pvValue: the new value
1325 Dim cstThisSub As String
1326 Const cstSubArgs = ""
1329 _PropertySet = False
1331 SF_Exception._CaptureSystemError()
1333 ' Argument validation must be manual to preserve system error status
1334 ' If wrong VarType then property set is ignored
1335 Select Case psProperty
1337 If VarType(pvValue) = V_STRING Then _Description = pvValue
1339 Select Case SF_Utils._VarTypeExt(pvValue)
1340 Case V_STRING
1341 _Number = pvValue
1342 Case V_NUMERIC
1343 _Number = CLng(pvValue)
1345 Case V_EMPTY
1346 _Number = Empty
1347 Case Else
1348 End Select
1350 Select Case SF_Utils._VarTypeExt(pvValue)
1351 Case V_STRING
1352 _Source = pvValue
1353 Case V_NUMERIC
1354 _Source = CLng(pvValue)
1355 Case Else
1356 End Select
1357 Case Else
1358 End Select
1360 _PropertySet = True
1362 Finally:
1363 Exit Function
1364 End Function ' ScriptForge.SF_Exception._PropertySet
1366 REM -----------------------------------------------------------------------------
1367 Private Function _Repr() As String
1368 ''' Convert the Exception instance to a readable string, typically for debugging purposes (DebugPrint ...)
1369 ''' Args:
1370 ''' Return:
1373 _Repr = "[Exception]: " & _Number & " (" & _Description & ")"
1375 End Function ' ScriptForge.SF_Exception._Repr
1377 REM -----------------------------------------------------------------------------
1378 Private Function _RightCase(psString As String) As String
1379 ''' Return the input argument in lower case only when the procedure in execution
1380 ''' has been triggered from a Python script
1381 ''' Indeed, Python requires lower case arguments
1382 ''' Args:
1383 ''' psString: probably an identifier in ProperCase
1384 ''' Return:
1385 ''' The input argument in lower case or left unchanged depending on the execution context
1387 Try:
1388 If _SF_.TriggeredByPython Then _RightCase = LCase(psString) Else _RightCase = psString
1390 Finally:
1391 Exit Function
1392 End Function ' ScriptForge.SF_Exception._RightCase
1394 REM -----------------------------------------------------------------------------
1395 Private Function _RightCaseArgs(psString As String) As String
1396 ''' Return the input argument unchanged when the execution context is Basic
1397 ''' When it is Python, the argument names are lowercased.
1398 ''' Args:
1399 ''' psString: one of the cstSubArgs strings located in each official method
1400 ''' Return:
1401 ''' The input string in which the argument names are put in lower case when called from Python scripts
1403 Dim sSubArgs As String ' Return value
1404 Dim vArgs As Variant ' Input string split on the comma character
1405 Dim sSingleArg As String ' Single vArgs item
1406 Dim vSingleArgs As Variant ' vSingleArg split on equal sign
1407 Dim i As Integer
1412 Try:
1413 If Len(psString) = 0 Then
1414 sSubArgs = ""
1415 ElseIf _SF_.TriggeredByPython Then
1416 vArgs = SF_String.SplitNotQuoted(psString, cstComma, QuoteChar := """")
1417 For i = 0 To UBound(vArgs)
1418 sSingleArg = vArgs(i)
1419 vSingleArgs = Split(sSingleArg, cstEqual)
1421 vArgs(i) = join(vSingleArgs, cstEqual)
1422 Next i
1423 sSubArgs = Join(vArgs, cstComma)
1424 Else
1425 sSubArgs = psString
1426 End If
1428 Finally:
1429 _RightCaseArgs = sSubArgs
1430 Exit Function
1431 End Function ' ScriptForge.SF_Exception._RightCaseArgs
1433 REM ============================================ END OF SCRIPTFORGE.SF_EXCEPTION
1434 </script:module>