| blob | 6bc6b236f3f3b860cd2dd26e24fa674b436fd248 |
3 <script:module xmlns:script="http://openoffice.org/2000/script" script:name="SF_L10N" 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 ClassModule
10 'Option Private Module
12 Option Explicit
14 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
15 ''' L10N (aka SF_L10N)
16 ''' ====
17 ''' Implementation of a Basic class for providing a number of services
18 ''' related to the translation of user interfaces into a huge number of languages
19 ''' with a minimal impact on the program code itself
20 '''
21 ''' The design choices of this module are based on so-called PO-files
22 ''' PO-files (portable object files) have long been promoted in the free software industry
23 ''' as a mean of providing multilingual UIs. This is accomplished through the use of human-readable
24 ''' text files with a well defined structure that specifies, for any given language,
25 ''' the source language string and the localized string
26 '''
27 ''' To read more about the PO format and its ecosystem of associated toolsets:
28 ''' https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html#PO-Files
29 ''' and, IMHO, a very good tutorial:
30 ''' http://pology.nedohodnik.net/doc/user/en_US/ch-about.html
31 '''
32 ''' The main advantage of the PO format is the complete dissociation between the two
33 ''' very different profiles, i.e. the programmer and the translator(s).
34 ''' Being independent text files, one per language to support, the programmer may give away
35 ''' pristine PO template files (known as POT-files) for a translator to process.
36 '''
39 ''' meant for being translated later
40 ''' 2. AddTextsFromDialog: to automatically execute AddText() on each fixed text of a dialog
43 ''' Note that the first two are optional: POT and PO-files may be built with a simple text editor
44 '''
45 ''' Several instances of the L10N class may coexist
46 ' The constraint however is that each instance should find its PO-files
47 ''' in a separate directory
48 ''' PO-files must be named with the targeted locale: f.i. "en-US.po" or "fr-BE.po"
49 '''
50 ''' Service invocation syntax
52 ''' FolderName: the folder containing the PO-files (in SF_FileSystem.FileNaming notation)
53 ''' Locale: in the form la-CO (language-COUNTRY)
55 ''' Use one of the Names listed in https://www.iana.org/assignments/character-sets/character-sets.xhtml
56 ''' Locale2: fallback Locale to select if Locale po file does not exist (typically "en-US")
58 ''' Service invocation examples:
59 ''' Dim myPO As Variant
60 ''' myPO = CreateScriptService("L10N") ' AddText, AddTextsFromDialog and ExportToPOTFile are allowed
61 ''' myPO = CreateScriptService("L10N", "C:\myPOFiles\", "fr-BE")
62 ''' 'All functionalities are available
63 '''
64 ''' Detailed user documentation:
65 ''' https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_l10n.html?DbPAR=BASIC
66 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
68 REM =============================================================== PRIVATE TYPES
70 ''' The recognized elements of an entry in a PO file are (other elements are ignored) :
71 ''' #. Extracted comments (given by the programmer to the translator)
72 ''' #, flag (the kde-format flag when the string contains tokens)
73 ''' msgctxt Context (to store an acronym associated with the message, this is a distortion of the norm)
74 ''' msgid untranslated-string
75 ''' msgstr translated-string
76 ''' NB: plural forms are not supported
78 Type POEntry
79 Comment As String
80 Flag As String
81 Context As String
82 MsgId As String
83 MsgStr As String
84 End Type
86 REM ================================================================== EXCEPTIONS
90 REM ============================================================= PRIVATE MEMBERS
92 Private [Me] As Object
93 Private [_Parent] As Object
95 Private ServiceName As String
96 Private _POFolder As String ' PO files container
97 Private _Locale As String ' la-CO
98 Private _POFile As String ' PO file in URL format
100 Private _Dictionary As Object ' SF_Dictionary
102 REM ===================================================== CONSTRUCTOR/DESTRUCTOR
104 REM -----------------------------------------------------------------------------
105 Private Sub Class_Initialize()
106 Set [Me] = Nothing
107 Set [_Parent] = Nothing
110 _POFolder = ""
111 _Locale = ""
112 _POFile = ""
113 Set _Dictionary = Nothing
114 End Sub ' ScriptForge.SF_L10N Constructor
116 REM -----------------------------------------------------------------------------
117 Private Sub Class_Terminate()
119 If Not IsNull(_Dictionary) Then Set _Dictionary = _Dictionary.Dispose()
120 Call Class_Initialize()
121 End Sub ' ScriptForge.SF_L10N Destructor
123 REM -----------------------------------------------------------------------------
124 Public Function Dispose() As Variant
125 Call Class_Terminate()
126 Set Dispose = Nothing
127 End Function ' ScriptForge.SF_L10N Explicit Destructor
129 REM ================================================================== PROPERTIES
131 REM -----------------------------------------------------------------------------
132 Property Get Folder() As String
133 ''' Returns the FolderName containing the PO-files expressed as given by the current FileNaming
134 ''' property of the SF_FileSystem service. Default = URL format
135 ''' May be empty
136 ''' Example:
137 ''' myPO.Folder
141 End Property ' ScriptForge.SF_L10N.Folder
143 REM -----------------------------------------------------------------------------
144 Property Get Languages() As Variant
145 ''' Returns a zero-based array listing all the BaseNames of the PO-files found in Folder,
146 ''' Example:
147 ''' myPO.Languages
151 End Property ' ScriptForge.SF_L10N.Languages
153 REM -----------------------------------------------------------------------------
154 Property Get Locale() As String
155 ''' Returns the currently active language-COUNTRY combination. May be empty
156 ''' Example:
157 ''' myPO.Locale
161 End Property ' ScriptForge.SF_L10N.Locale
163 REM ===================================================================== METHODS
165 REM -----------------------------------------------------------------------------
166 Public Function AddText(Optional ByVal Context As Variant _
167 , Optional ByVal MsgId As Variant _
168 , Optional ByVal Comment As Variant _
169 , Optional ByVal MsgStr As Variant _
170 ) As Boolean
171 ''' Add a new entry in the list of localizable text strings
172 ''' Args:
173 ''' Context: when not empty, the key to retrieve the translated string via GetText. Default = ""
174 ''' MsgId: the untranslated string, i.e. the text appearing in the program code. Must not be empty
175 ''' The key to retrieve the translated string via GetText when Context is empty
176 ''' May contain placeholders (%1 ... %9) for dynamic arguments to be inserted in the text at run-time
177 ''' If the string spans multiple lines, insert escape sequences (\n) where relevant
178 ''' Comment: the so-called "extracted-comments" intended to inform/help translators
179 ''' If the string spans multiple lines, insert escape sequences (\n) where relevant
180 ''' MsgStr: (internal use only) the translated string
181 ''' If the string spans multiple lines, insert escape sequences (\n) where relevant
182 ''' Returns:
183 ''' True if successful
184 ''' Exceptions:
185 ''' DUPLICATEKEYERROR: such a key exists already
186 ''' Examples:
189 Dim bAdd As Boolean ' Output buffer
190 Dim sKey As String ' The key part of the new entry in the dictionary
191 Dim vItem As POEntry ' The item part of the new entry in the dictionary
194 Const cstSubArgs = "[Context=""""], MsgId, [Comment=""""]"
196 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
197 bAdd = False
199 Check:
200 If IsMissing(Context) Or IsMissing(Context) Then Context = ""
201 If IsMissing(Comment) Or IsMissing(Comment) Then Comment = ""
202 If IsMissing(MsgStr) Or IsMissing(MsgStr) Then MsgStr = ""
203 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
208 End If
209 If Len(MsgId) = 0 Then GoTo Finally
211 Try:
213 If _Dictionary.Exists(sKey) Then GoTo CatchDuplicate
215 With vItem
216 .Comment = Comment
217 If InStr(MsgId, "%") > 0 Then .Flag = "kde-format" Else .Flag = ""
218 .Context = Replace(Context, cstPipe, " ")
219 .MsgId = Replace(MsgId, cstPipe, " ")
220 .MsgStr = MsgStr
221 End With
222 _Dictionary.Add(sKey, vItem)
223 bAdd = True
225 Finally:
226 AddText = bAdd
227 SF_Utils._ExitFunction(cstThisSub)
228 Exit Function
229 Catch:
230 GoTo Finally
231 CatchDuplicate:
232 SF_Exception.RaiseFatal(DUPLICATEKEYERROR, Iif(Len(Context) > 0, "Context", "MsgId"), sKey)
233 GoTo Finally
234 End Function ' ScriptForge.SF_L10N.AddText
236 REM -----------------------------------------------------------------------------
237 Public Function AddTextsFromDialog(Optional ByRef Dialog As Variant) As Boolean
238 ''' Add all fixed text strings of a dialog to the list of localizable text strings
239 ''' Added texts are:
240 ''' - the title of the dialog
241 ''' - the caption associated with next control types: Button, CheckBox, FixedLine, FixedText, GroupBox and RadioButton
242 ''' - the content of list- and comboboxes
243 ''' - the tip- or helptext displayed when the mouse is hovering the control
244 ''' The current method has method SFDialogs.SF_Dialog.GetTextsFromL10N as counterpart
245 ''' The targeted dialog must not be open when the current method is run
246 ''' Args:
247 ''' Dialog: a SFDialogs.Dialog service instance
248 ''' Returns:
249 ''' True when successful
250 ''' Examples:
251 ''' Dim myDialog As Object
252 ''' Set myDialog = CreateScriptService("SFDialogs.Dialog", "GlobalScope", "XrayTool", "DlgXray")
253 ''' myPO.AddTextsFromDialog(myDialog)
255 Dim bAdd As Boolean ' Return value
256 Dim vControls As Variant ' Array of control names
257 Dim sControl As String ' A single control name
258 Dim oControl As Object ' SFDialogs.DialogControl
259 Dim sText As String ' The text to insert in the dictionary
260 Dim sDialogComment As String ' The prefix in the comment to insert in the dictionary for the dialog
261 Dim sControlComment As String ' The prefix in the comment to insert in the dictionary for a control
262 Dim vSource As Variant ' RowSource property of dialog control as an array
263 Dim i As Long
268 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
269 bAdd = False
271 Check:
272 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
273 If Not SF_Utils._Validate(Dialog, "Dialog", V_OBJECT, , , "DIALOG") Then GoTo Finally
274 End If
276 Try:
277 With Dialog
278 ' Store the title of the dialog
279 sDialogComment = "Dialog => " & ._Container & " : " & ._Library & " : " & ._Name & " : "
280 stext = .Caption
282 If Not _ReplaceText("", sText, sDialogComment & "Caption") Then GoTo Catch
283 End If
284 ' Scan all controls
285 vControls = .Controls()
286 For Each sControl In vControls
287 Set oControl = .Controls(sControl)
289 With oControl
290 ' Extract fixed texts
291 sText = .Caption
293 If Not _ReplaceText("", sText, sControlComment & "Caption") Then GoTo Catch
294 End If
295 vSource = .RowSource ' List and comboboxes only
296 If IsArray(vSource) Then
297 For i = 0 To UBound(vSource)
299 If Not _ReplaceText("", vSource(i), sControlComment & "RowSource[" & i & "]") Then GoTo Catch
300 End If
301 Next i
302 End If
303 sText = .TipText
305 If Not _ReplaceText("", sText, sControlComment & "TipText") Then GoTo Catch
306 End If
307 End With
308 Next sControl
309 End With
311 bAdd = True
313 Finally:
314 AddTextsFromDialog = bAdd
315 SF_Utils._ExitFunction(cstThisSub)
316 Exit Function
317 Catch:
318 GoTo Finally
319 End Function ' ScriptForge.SF_L10N.AddTextsFromDialog
321 REM -----------------------------------------------------------------------------
322 Public Function ExportToPOTFile(Optional ByVal FileName As Variant _
323 , Optional ByVal Header As Variant _
324 , Optional ByVal Encoding As Variant _
325 ) As Boolean
326 ''' Export a set of untranslated strings as a POT file
327 ''' The set of strings has been built either by a succession of AddText() methods
328 ''' or by a successful invocation of the L10N service with the FolderName argument
329 ''' The generated file should pass successfully the "msgfmt --check 'the pofile'" GNU command
330 ''' Args:
331 ''' FileName: the complete file name to export to. If it exists, is overwritten without warning
332 ''' Header: Comments that will appear on top of the generated file. Do not include any leading "#"
333 ''' If the string spans multiple lines, insert escape sequences (\n) where relevant
334 ''' A standard header will be added anyway
335 ''' Encoding: The character set that should be used
336 ''' Use one of the Names listed in https://www.iana.org/assignments/character-sets/character-sets.xhtml
337 ''' Note that LibreOffice probably does not implement all existing sets
339 ''' Returns:
340 ''' True if successful
341 ''' Examples:
342 ''' myPO.ExportToPOTFile("myFile.pot", Header := "Top comment\nSecond line of top comment")
344 Dim bExport As Boolean ' Return value
345 Dim oFile As Object ' Generated file handler
346 Dim vLines As Variant ' Wrapped lines
347 Dim sLine As String ' A single line
348 Dim vItems As Variant ' Array of dictionary items
349 Dim vItem As Variant ' POEntry type
350 Const cstSharp = "# ", cstSharpDot = "#. ", cstFlag = "#, kde-format"
351 Const cstTabSize = 4
352 Const cstWrap = 70
354 Const cstSubArgs = "FileName, [Header=""""], [Encoding=""UTF-8"""
356 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
357 bExport = False
359 Check:
360 If IsMissing(Header) Or IsEmpty(Header) Then Header = ""
362 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
366 End If
368 Try:
369 Set oFile = SF_FileSystem.CreateTextFile(FileName, Overwrite := True, Encoding := Encoding)
370 If Not IsNull(oFile) Then
371 With oFile
372 ' Standard header
373 .WriteLine(cstSharp)
374 .WriteLine(cstSharp & "This pristine POT file has been generated by LibreOffice/ScriptForge")
375 .WriteLine(cstSharp & "Full documentation is available on https://help.libreoffice.org/")
376 ' User header
378 .WriteLine(cstSharp)
379 vLines = SF_String.Wrap(Header, cstWrap, cstTabSize)
380 For Each sLine In vLines
382 Next sLine
383 End If
384 ' Standard header
385 .WriteLine(cstSharp)
390 & "https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n"))
391 .WriteLine(SF_String.Quote("POT-Creation-Date: " & SF_STring.Represent(Now()) & "\n"))
397 .WriteLine(SF_String.Quote("Content-Type: text/plain; charset=" & Encoding & "\n"))
402 ' Individual translatable strings
403 vItems = _Dictionary.Items()
404 For Each vItem in vItems
405 .WriteBlankLines(1)
406 ' Comments
408 For Each sLine In vLines
409 .WriteLine(cstSharpDot & SF_String.ExpandTabs(SF_String.Unescape(sLine), cstTabSize))
410 Next sLine
411 ' Flag
413 ' Context
416 End If
417 ' MsgId
418 vLines = SF_String.Wrap(vItem.MsgId, cstWrap, cstTabSize)
419 If UBound(vLines) = 0 Then
421 Else
423 For Each sLine in vLines
424 .WriteLine(SF_String.Quote(SF_String.Escape(sLine)))
425 Next sLine
426 End If
427 ' MsgStr
429 Next vItem
430 .CloseFile()
431 End With
432 End If
433 bExport = True
435 Finally:
436 If Not IsNull(oFile) Then Set oFile = oFile.Dispose()
437 ExportToPOTFile = bExport
438 SF_Utils._ExitFunction(cstThisSub)
439 Exit Function
440 Catch:
441 GoTo Finally
442 End Function ' ScriptForge.SF_L10N.ExportToPOTFile
444 REM -----------------------------------------------------------------------------
445 Public Function GetProperty(Optional ByVal PropertyName As Variant) As Variant
446 ''' Return the actual value of the given property
447 ''' Args:
448 ''' PropertyName: the name of the property as a string
449 ''' Returns:
450 ''' The actual value of the property
451 ''' If the property does not exist, returns Null
452 ''' Exceptions:
453 ''' ARGUMENTERROR The property does not exist
454 ''' Examples:
458 Const cstSubArgs = ""
460 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
461 GetProperty = Null
463 Check:
464 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
465 If Not SF_Utils._Validate(PropertyName, "PropertyName", V_STRING, Properties()) Then GoTo Catch
466 End If
468 Try:
469 GetProperty = _PropertyGet(PropertyName)
471 Finally:
472 SF_Utils._ExitFunction(cstThisSub)
473 Exit Function
474 Catch:
475 GoTo Finally
476 End Function ' ScriptForge.SF_L10N.GetProperty
478 REM -----------------------------------------------------------------------------
479 Public Function GetText(Optional ByVal MsgId As Variant _
480 , ParamArray pvArgs As Variant _
481 ) As String
482 ''' Get the translated string corresponding with the given argument
483 ''' Args:
484 ''' MsgId: the identifier of the string or the untranslated string
485 ''' Either - the untranslated text (MsgId)
486 ''' - the reference to the untranslated text (Context)
487 ''' - both (Context|MsgId) : the pipe character is essential
488 ''' pvArgs(): a list of arguments present as %1, %2, ... in the (un)translated string)
489 ''' to be substituted in the returned string
490 ''' Any type is admitted but only strings, numbers or dates are relevant
491 ''' Returns:
492 ''' The translated string
493 ''' If not found the MsgId string or the Context string
494 ''' Anyway the substitution is done
495 ''' Examples:
497 ''' ' Ceci est un text à inclure dans un fichier POT
499 Dim sText As String ' Output buffer
500 Dim sContext As String ' Context part of argument
501 Dim sMsgId As String ' MsgId part of argument
502 Dim vItem As POEntry ' Entry in the dictionary
503 Dim vMsgId As Variant ' MsgId split on pipe
504 Dim sKey As String ' Key of dictionary
506 Dim i As Long
511 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
512 sText = ""
514 Check:
515 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
517 End If
518 If Len(Trim(MsgId)) = 0 Then GoTo Finally
519 sText = MsgId
521 Try:
522 ' Find and load entry from dictionary
524 vMsgId = Split(MsgId, cstPipe)
525 sKey = vMsgId(0)
526 If Not _Dictionary.Exists(sKey) Then ' Not found
528 Else
529 vItem = _Dictionary.Item(sKey)
531 End If
533 ' Substitute %i placeholders
536 sText = Replace(sText, sPercent, SF_String.Represent(pvArgs(i)))
537 Next i
539 Finally:
540 GetText = sText
541 SF_Utils._ExitFunction(cstThisSub)
542 Exit Function
543 Catch:
544 GoTo Finally
545 End Function ' ScriptForge.SF_L10N.GetText
547 REM - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
548 Public Function _(Optional ByVal MsgId As Variant _
549 , ParamArray pvArgs As Variant _
550 ) As String
551 ''' Get the translated string corresponding with the given argument
552 ''' Alias of GetText() - See above
553 ''' Examples:
555 ''' ' Ceci est un text à inclure dans un fichier POT
557 Dim sText As String ' Output buffer
559 Dim i As Long
564 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
565 sText = ""
567 Check:
568 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
570 End If
571 If Len(Trim(MsgId)) = 0 Then GoTo Finally
573 Try:
574 ' Find and load entry from dictionary
575 sText = GetText(MsgId)
577 ' Substitute %i placeholders - done here, not in GetText(), because # of arguments is undefined
578 For i = 0 To UBound(pvArgs)
580 sText = Replace(sText, sPercent, SF_String.Represent(pvArgs(i)))
581 Next i
583 Finally:
584 _ = sText
585 SF_Utils._ExitFunction(cstThisSub)
586 Exit Function
587 Catch:
588 GoTo Finally
589 End Function ' ScriptForge.SF_L10N._
591 REM -----------------------------------------------------------------------------
592 Public Function Methods() As Variant
593 ''' Return the list of public methods of the L10N service as an array
595 Methods = Array( _
601 )
603 End Function ' ScriptForge.SF_L10N.Methods
605 REM -----------------------------------------------------------------------------
606 Public Function Properties() As Variant
607 ''' Return the list or properties of the Timer class as an array
609 Properties = Array( _
613 )
615 End Function ' ScriptForge.SF_L10N.Properties
617 REM -----------------------------------------------------------------------------
618 Public Function SetProperty(Optional ByVal PropertyName As Variant _
619 , Optional ByRef Value As Variant _
620 ) As Boolean
621 ''' Set a new value to the given property
622 ''' Args:
623 ''' PropertyName: the name of the property as a string
624 ''' Value: its new value
625 ''' Exceptions
626 ''' ARGUMENTERROR The property does not exist
631 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
632 SetProperty = False
634 Check:
635 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
636 If Not SF_Utils._Validate(PropertyName, "PropertyName", V_STRING, Properties()) Then GoTo Catch
637 End If
639 Try:
640 Select Case UCase(PropertyName)
641 Case Else
642 End Select
644 Finally:
645 SF_Utils._ExitFunction(cstThisSub)
646 Exit Function
647 Catch:
648 GoTo Finally
649 End Function ' ScriptForge.SF_L10N.SetProperty
651 REM =========================================================== PRIVATE FUNCTIONS
653 REM -----------------------------------------------------------------------------
654 Public Sub _Initialize(ByVal psPOFile As String _
655 , ByVal Encoding As String _
656 )
657 ''' Completes initialization of the current instance requested from CreateScriptService()
658 ''' Load the POFile in the dictionary, otherwise leave the dictionary empty
659 ''' Args:
660 ''' psPOFile: the file to load the translated strings from
663 Dim oFile As Object ' PO file handler
664 Dim sContext As String ' Collected context string
665 Dim sMsgId As String ' Collected untranslated string
666 Dim sComment As String ' Collected comment string
667 Dim sMsgStr As String ' Collected translated string
668 Dim sLine As String ' Last line read
672 Try:
673 ' Initialize dictionary anyway
675 Set _Dictionary.[_Parent] = [Me]
677 ' Load PO file
679 With SF_FileSystem
680 _POFolder = ._ConvertToUrl(.GetParentFolderName(psPOFile))
681 _Locale = .GetBaseName(psPOFile)
682 _POFile = ._ConvertToUrl(psPOFile)
683 End With
684 ' Load PO file
685 Set oFile = SF_FileSystem.OpenTextFile(psPOFile, IOMode := SF_FileSystem.ForReading, Encoding := Encoding)
686 If Not IsNull(oFile) Then
687 With oFile
689 sContext = "" : sMsgId = "" : sComment = "" : sMsgStr = ""
690 Do While Not .AtEndOfStream
691 sLine = Trim(.ReadLine())
692 ' Trivial examination of line header
693 Select Case True
694 Case sLine = ""
696 sContext = "" : sMsgId = "" : sComment = "" : sMsgStr = ""
697 iContinue = 0
699 sComment = sComment & Iif(Len(sComment) > 0, "\n", "") & Trim(Mid(sLine, 4))
700 iContinue = 0
702 sContext = SF_String.Unquote(Trim(Mid(sLine, 9)))
703 iContinue = 0
705 sMsgId = SF_String.Unquote(Trim(Mid(sLine, 7)))
706 iContinue = cstMsgId
709 iContinue = cstMsgStr
711 If iContinue = cstMsgId Then
712 sMsgId = sMsgId & SF_String.Unquote(sLine)
713 ElseIf iContinue = cstMsgStr Then
714 sMsgStr = sMsgStr & SF_String.Unquote(sLine)
715 Else
716 iContinue = 0
717 End If
718 Case Else ' Skip line
719 iContinue = 0
720 End Select
721 Loop
722 ' Be sure to store the last entry
724 .CloseFile()
725 Set oFile = .Dispose()
726 End With
727 End If
728 Else
729 _POFolder = ""
730 _Locale = ""
731 _POFile = ""
732 End If
734 Finally:
735 Exit Sub
736 End Sub ' ScriptForge.SF_L10N._Initialize
738 REM -----------------------------------------------------------------------------
739 Private Function _PropertyGet(Optional ByVal psProperty As String)
740 ''' Return the value of the named property
741 ''' Args:
742 ''' psProperty: the name of the property
744 Dim vFiles As Variant ' Array of PO-files
745 Dim i As Long
746 Dim cstThisSub As String
747 Dim cstSubArgs As String
750 cstSubArgs = ""
751 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
753 With SF_FileSystem
754 Select Case psProperty
756 If Len(_POFolder) > 0 Then _PropertyGet = ._ConvertFromUrl(_POFolder) Else _PropertyGet = ""
760 For i = 0 To UBound(vFiles)
761 vFiles(i) = SF_FileSystem.GetBaseName(vFiles(i))
762 Next i
763 Else
764 vFiles = Array()
765 End If
766 _PropertyGet = vFiles
768 _PropertyGet = _Locale
769 Case Else
770 _PropertyGet = Null
771 End Select
772 End With
774 Finally:
775 SF_Utils._ExitFunction(cstThisSub)
776 Exit Function
777 End Function ' ScriptForge.SF_L10N._PropertyGet
779 REM -----------------------------------------------------------------------------
780 Private Function _ReplaceText(ByVal psContext As String _
781 , ByVal psMsgId As String _
782 , ByVal psComment As String _
783 ) As Boolean
784 ''' When the entry in the dictionary does not yet exist, equivalent to AddText
785 ''' When it exists already, extend the existing comment with the psComment argument
786 ''' Used from AddTextsFromDialog to manage identical strings without raising errors,
789 Dim bAdd As Boolean ' Return value
790 Dim sKey As String ' The key part of an entry in the dictionary
791 Dim vItem As POEntry ' The item part of the new entry in the dictionary
793 Try:
794 bAdd = False
796 If _Dictionary.Exists(sKey) Then
797 ' Load the entry, adapt comment and rewrite
798 vItem = _Dictionary.Item(sKey)
799 If Len(vItem.Comment) = 0 Then vItem.Comment = psComment Else vItem.Comment = vItem.Comment & "\n" & psComment
800 bAdd = _Dictionary.ReplaceItem(sKey, vItem)
801 Else
802 ' Add a new entry as usual
803 bAdd = AddText(psContext, psMsgId, psComment)
804 End If
806 Finally:
807 _ReplaceText = bAdd
808 Exit Function
809 Catch:
810 GoTo Finally
811 End Function ' ScriptForge.SF_L10N._ReplaceText
813 REM -----------------------------------------------------------------------------
814 Private Function _Repr() As String
815 ''' Convert the L10N instance to a readable string, typically for debugging purposes (DebugPrint ...)
816 ''' Args:
817 ''' Return:
822 End Function ' ScriptForge.SF_L10N._Repr
824 REM ============================================ END OF SCRIPTFORGE.SF_L10N
825 </script:module>