Jump to content

OpenOffice/LibreOffice Spell Checker

GMK

By GMK,
in AutoIt Example Scripts

 Share

Recommended Posts

GMK Universalist

GMK

Posted
Posted (edited)

@mLipok asked me to come up with an AutoIt example for this.

So here's what I came up with, including an added bonus. 

#include <Array.au3>

Global $oMyError = ObjEvent('AutoIt.Error', '_ErrFunc')

Global $sLocale = 'en'
Global $sCountry = 'US'
Global $sWord = InputBox("Spell Checker", "File to check (empty for end)?")
While $sWord <> ""
    Global $vSpell = _OOo_SpellChecker($sWord, $sLocale, $sCountry)
    If $vSpell Then
        MsgBox(0, "Spell Checker", $sWord & " is valid")
    Else
        If MsgBox(4, "Spell Checker", $sWord & " is NOT valid. Would you like to see alternatives?") = 6 Then
            Global $aAlternatives = _OOo_SpellChecker($sWord, $sLocale, $sCountry, True)
            _ArrayDisplay($aAlternatives, "Spell Checker")
        EndIf
    EndIf
    $sWord = InputBox("Spell Checker", "File to check (empty for end)?")
WEnd

; #FUNCTION# ====================================================================================================================
; Name ..........: _OOo_SpellChecker
; Description ...: Checks a single word with the OpenOffice/LibreOffice spell checker to see if it is spelled correctly in a
;                  given locale.
; Syntax ........: _OOo_SpellChecker($sWord[, $sLocale = 'en'[, $sCountry = 'US'[, $bShowAlternatives = False]]])
; Parameters ....: $sWord             - a string value.
;                  $sLocale           - [optional] a string value. Default is 'en'.
;                  $sCountry          - [optional] a string value. Default is 'US'.
;                  $bShowAlternatives - [optional] a boolean value. Default is False.
; Return values .: On Success         - Returns True if the word is spelled correctly using the specified language, False
;                                       otherwise. If word is not spelled correctly and $bShowAlternatives is set to True,
;                                       an array of suggestions is returned.
;                  On Failure         - Returns 0 and sets @error and @extended:
;                  |                    @error    = 0 - Success (No error)
;                  |                                1 - General error
;                  |                                2 - Invalid type
;                  |                                3 - Invalid value
;                  |                                4 - No match found
;                  |                    @extended = number of offending parameter
; Author ........: GMK
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: https://www.openoffice.org/api/docs/common/ref/com/sun/star/linguistic2/XSpellChecker.html
;                  https://www.openoffice.org/api/docs/common/ref/com/sun/star/linguistic2/XSpellAlternatives.html
;                  http://www.loc.gov/standards/iso639-2/php/code_list.php
;                  https://www.iso.org/obp/ui/#search
; Example .......: Yes
; ===============================================================================================================================
Func _OOo_SpellChecker($sWord, $sLocale = 'en', $sCountry = 'US', $bShowAlternatives = False)
    Local Enum $eErr_Success, _
            $eErr_GeneralError, _
            $eErr_InvalidType, _
            $eErr_InvalidValue, _
            $eErr_NoMatch
    If Not IsString($sWord) Then Return SetError($eErr_InvalidType, 1, 0)
    If StringRegExp($sWord, '\d|\s') Then Return SetError($eErr_InvalidValue, 1, 0)
    If Not IsString($sLocale) Then Return SetError($eErr_InvalidType, 2, 0)
    If StringLen($sLocale) <> 2 Then Return SetError($eErr_InvalidValue, 2, 0)
    If Not IsString($sCountry) Then Return SetError($eErr_InvalidType, 3, 0)
    If StringLen($sCountry) <> 2 Then Return SetError($eErr_InvalidValue, 3, 0)
    Local $oSM = ObjCreate('com.sun.star.ServiceManager')
    If Not IsObj($oSM) Then Return SetError($eErr_GeneralError, 10, 0)
    Local $oLocale = $oSM.Bridge_GetStruct('com.sun.star.lang.Locale')
    If Not IsObj($oLocale) Then Return SetError($eErr_GeneralError, 11, 0)
    $oLocale.Language = $sLocale
    $oLocale.Country = $sCountry
    Local $oLinguService = $oSM.createInstance('com.sun.star.linguistic2.LinguServiceManager')
    If Not IsObj($oLinguService) Then Return SetError($eErr_GeneralError, 12, 0)
    Local $oSpellChecker = $oLinguService.getSpellChecker
    If Not IsObj($oSpellChecker) Then Return SetError($eErr_GeneralError, 13, 0)
    If Not $oSpellChecker.hasLocale($oLocale) Then Return SetError($eErr_NoMatch, 2, 0)
    Local $oPropertyValue = $oSM.Bridge_GetStruct('com.sun.star.beans.PropertyValue')
    If Not IsObj($oPropertyValue) Then Return SetError($eErr_GeneralError, 14, 0)
    Local $aPropertyValue[1] = [$oPropertyValue]
    Local $nRandom = Random(0, 0.5)
    Local $bReturn = $oSpellChecker.isValid($sWord, $nRandom, $aPropertyValue)
    If @error Then Return SetError($eErr_GeneralError, 15, 0)
    If Not $bReturn And $bShowAlternatives Then
        Local $oSpell = $oSpellChecker.spell($sWord, $nRandom, $aPropertyValue)
        If Not IsObj($oSpell) Then Return SetError($eErr_GeneralError, 16, 0)
        Local $aReturn = $oSpell.getAlternatives()
        Local $iAlternatives = UBound($aReturn)
        ReDim $aReturn[$iAlternatives + 1]
        $iAlternatives += 1
        For $i = $iAlternatives - 1 To 1 Step -1
            $aReturn[$i] = $aReturn[$i - 1]
        Next
        $aReturn[0] = $oSpell.getAlternativesCount()
        If @error Then Return SetError($eErr_GeneralError, 17, 0)
        Return SetError($eErr_Success, 0, $aReturn)
    EndIf
    Return SetError($eErr_Success, 0, $bReturn)
EndFunc

Func _ErrFunc($oError)
    ConsoleWrite(@ScriptName & ' (' & $oError.scriptline & ') : ==> COM Error intercepted !' & @CRLF & _
            @TAB & 'err.number is: ' & @TAB & @TAB & '0x' & Hex($oError.number) & @CRLF & _
            @TAB & 'err.windescription:' & @TAB & $oError.windescription & @CRLF & _
            @TAB & 'err.description is: ' & @TAB & $oError.description & @CRLF & _
            @TAB & 'err.source is: ' & @TAB & @TAB & $oError.source & @CRLF & _
            @TAB & 'err.helpfile is: ' & @TAB & $oError.helpfile & @CRLF & _
            @TAB & 'err.helpcontext is: ' & @TAB & $oError.helpcontext & @CRLF & _
            @TAB & 'err.lastdllerror is: ' & @TAB & $oError.lastdllerror & @CRLF & _
            @TAB & 'err.scriptline is: ' & @TAB & $oError.scriptline & @CRLF & _
            @TAB & 'err.retcode is: ' & @TAB & '0x' & Hex($oError.retcode) & @CRLF & @CRLF)
EndFunc   ;==>_ErrFunc

 

Edited by GMK
Edited tags
Link to comment
Share on other sites
mLipok Universalist

mLipok

Posted
Posted (edited)

@GMK Thanks for this Function, this is very handy !

I just make a small modyfication for example: 

#include <MsgBoxConstants.au3>
#include <Array.au3>
#include <WinAPILocale.au3>

Global $oMyError = ObjEvent('AutoIt.Error', '_ErrFunc')

_Example()
Func _Example()
    Local $sLocale = 'pl'
    Local $sCountry = 'PL'
    Local $sWord = InputBox("Spell Checker", "Type single word to check (empty for end) ?")
    While $sWord <> ""
        Global $vSpell = _OOo_SpellChecker($sWord, $sLocale, $sCountry)
        If @error Then
            MsgBox($MB_ICONERROR, '_OOo_SpellChecker', '@error = ' & @error & @CRLF & '@extended = ' & @extended)
        ElseIf $vSpell Then
            MsgBox($MB_OK, "Spell Checker", $sWord & " is valid")
        Else
            If MsgBox($MB_YESNO, "Spell Checker", $sWord & " is NOT valid. Would you like to see alternatives?") = $IDYES Then
                Global $aAlternatives = _OOo_SpellChecker($sWord, $sLocale, $sCountry, True)
                _ArrayDisplay($aAlternatives, "Spell Checker")
            EndIf
        EndIf
        $sWord = InputBox("Spell Checker", "File to check (empty for end)?")
    WEnd
EndFunc

 

ps.
Try to not use magic numbers.

 

EDIT:
Small mod: 

Func _OOo_SpellChecker($sWord, $sLocale = 'en', $sCountry = 'US', $bShowAlternatives = False)
    Local Enum _
            $eErr_Success, _
            $eErr_GeneralError, _
            $eErr_InvalidType, _
            $eErr_InvalidValue, _
            $eErr_NoMatch

    If Not IsString($sWord) Then Return SetError($eErr_InvalidType, 1, 0)
    If StringRegExp($sWord, '\d|\s') Or $sWord = '' Then Return SetError($eErr_InvalidValue, 1, 0)
    If Not IsString($sLocale) Then Return SetError($eErr_InvalidType, 2, 0)
    If StringLen($sLocale) <> 2 Then Return SetError($eErr_InvalidValue, 2, 0)
    If Not IsString($sCountry) Then Return SetError($eErr_InvalidType, 3, 0)
    If StringLen($sCountry) <> 2 Then Return SetError($eErr_InvalidValue, 3, 0)

    Local $oSM = ObjCreate('com.sun.star.ServiceManager')
    If Not IsObj($oSM) Then Return SetError($eErr_GeneralError, 10, 0)

    Local $oLocale = $oSM.Bridge_GetStruct('com.sun.star.lang.Locale')
    If Not IsObj($oLocale) Then Return SetError($eErr_GeneralError, 11, 0)

    $oLocale.Language = $sLocale
    $oLocale.Country = $sCountry
    Local $oLinguService = $oSM.createInstance('com.sun.star.linguistic2.LinguServiceManager')
    If Not IsObj($oLinguService) Then Return SetError($eErr_GeneralError, 12, 0)

    Local $oSpellChecker = $oLinguService.getSpellChecker
    If Not IsObj($oSpellChecker) Then Return SetError($eErr_GeneralError, 13, 0)
    If Not $oSpellChecker.hasLocale($oLocale) Then Return SetError($eErr_NoMatch, 2, 0)

    Local $oPropertyValue = $oSM.Bridge_GetStruct('com.sun.star.beans.PropertyValue')
    If Not IsObj($oPropertyValue) Then Return SetError($eErr_GeneralError, 14, 0)

    Local $aPropertyValue[1] = [$oPropertyValue]
    Local $nRandom = Random(0, 0.5)
    Local $bReturn = $oSpellChecker.isValid($sWord, $nRandom, $aPropertyValue)
    If @error Then Return SetError($eErr_GeneralError, 15, 0)

    If Not $bReturn And $bShowAlternatives Then
        Local $oSpell = $oSpellChecker.spell($sWord, $nRandom, $aPropertyValue)
        If Not IsObj($oSpell) Then Return SetError($eErr_GeneralError, 16, 0)

        Local $aReturn = $oSpell.getAlternatives()
        Local $iAlternatives = UBound($aReturn)
        ReDim $aReturn[$iAlternatives + 1]
        $iAlternatives += 1
        For $i = $iAlternatives - 1 To 1 Step -1
            $aReturn[$i] = $aReturn[$i - 1]
        Next
        $aReturn[0] = $oSpell.getAlternativesCount()
        If @error Then Return SetError($eErr_GeneralError, 17, 0)
        Return SetError($eErr_Success, 0, $aReturn)
    EndIf

    Return SetError($eErr_Success, 0, $bReturn)
EndFunc   ;==>_OOo_SpellChecker

 

Edited by mLipok

Signature beginning:
* Please remember: "AutoIt"..... *  Wondering who uses AutoIt and what it can be used for ? * Forum Rules *
* ADO.au3 UDF * POP3.au3 UDF * XML.au3 UDF * IE on Windows 11 * How to ask ChatGPT for AutoIt Code * for other useful stuff click the following button:

Spoiler

Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind. 

My contribution (my own projects): * Debenu Quick PDF Library - UDF * Debenu PDF Viewer SDK - UDF * Acrobat Reader - ActiveX Viewer * UDF for PDFCreator v1.x.x * XZip - UDF * AppCompatFlags UDF * CrowdinAPI UDF * _WinMergeCompare2Files() * _JavaExceptionAdd() * _IsBeta() * Writing DPI Awareness App - workaround * _AutoIt_RequiredVersion() * Chilkatsoft.au3 UDF * TeamViewer.au3 UDF * JavaManagement UDF * VIES over SOAP * WinSCP UDF * GHAPI UDF - modest begining - comunication with GitHub REST API * ErrorLog.au3 UDF - A logging Library * Include Dependency Tree (Tool for analyzing script relations) * Show_Macro_Values.au3 *

 

My contribution to others projects or UDF based on  others projects: * _sql.au3 UDF  * POP3.au3 UDF *  RTF Printer - UDF * XML.au3 UDF * ADO.au3 UDF * SMTP Mailer UDF * Dual Monitor resolution detection * * 2GUI on Dual Monitor System * _SciLexer.au3 UDF * SciTE - Lexer for console pane * 

Useful links: * Forum Rules * Forum etiquette *  Forum Information and FAQs * How to post code on the forum * AutoIt Online Documentation * AutoIt Online Beta Documentation * SciTE4AutoIt3 getting started * Convert text blocks to AutoIt code * Games made in Autoit * Programming related sites * Polish AutoIt Tutorial * DllCall Code Generator * 

Wiki: * Expand your knowledge - AutoIt Wiki * Collection of User Defined Functions * How to use HelpFile * Good coding practices in AutoIt * 

OpenOffice/LibreOffice/XLS Related: WriterDemo.au3 * XLS/MDB from scratch with ADOX

IE Related:  * How to use IE.au3  UDF with  AutoIt v3.3.14.x * Why isn't Autoit able to click a Javascript Dialog? * Clicking javascript button with no ID * IE document >> save as MHT file * IETab Switcher (by LarsJ ) * HTML Entities * _IEquerySelectorAll() (by uncommon) * IE in TaskScheduler * IE Embedded Control Versioning (use IE9+ and HTML5 in a GUI) * PDF Related: * How to get reference to PDF object embeded in IE * IE on Windows 11 * 

I encourage you to read: * Global Vars * Best Coding Practices * Please explain code used in Help file for several File functions * OOP-like approach in AutoIt * UDF-Spec Questions *  EXAMPLE: How To Catch ConsoleWrite() output to a file or to CMD *

I also encourage you to check awesome @trancexx code:  * Create COM objects from modules without any demand on user to register anything. * Another COM object registering stuff * OnHungApp handler * Avoid "AutoIt Error" message box in unknown errors  * HTML editor * 

winhttp.au3 related : * https://www.autoitscript.com/forum/topic/206771-winhttpau3-download-problem-youre-speaking-plain-http-to-an-ssl-enabled-server-port/

"Homo sum; humani nil a me alienum puto" - Publius Terentius Afer
"Program are meant to be read by humans and only incidentally for computers and execute" - Donald Knuth, "The Art of Computer Programming"
:naughty:  :ranting:, be  :) and       \\//_.

Anticipating Errors :  "Any program that accepts data from a user must include code to validate that data before sending it to the data store. You cannot rely on the data store, ...., or even your programming language to notify you of problems. You must check every byte entered by your users, making sure that data is the correct type for its field and that required fields are not empty."

Signature last update: 2023-04-24

Link to comment
Share on other sites
GMK Universalist

GMK

Posted
  • Author
Posted (edited)

Hey, I just wrote this to fulfill a request.  I had no standards in mind, nor did I write it to be included in the next release.  I'm not sure how often I'll use it, but hopefully others will find a use for it.

 

P.S. Glad you like it!

Edited by GMK
P.S.
Link to comment
Share on other sites
mLipok Universalist

mLipok

Posted
Posted

I'm really grateful for this example.
But as usual, I just added my 2 cents, of course, not in order to upset you, I just simply shared my observations and ideas.
Sorry for the bad feelings.

mLipok

Signature beginning:
* Please remember: "AutoIt"..... *  Wondering who uses AutoIt and what it can be used for ? * Forum Rules *
* ADO.au3 UDF * POP3.au3 UDF * XML.au3 UDF * IE on Windows 11 * How to ask ChatGPT for AutoIt Code * for other useful stuff click the following button:

Spoiler

Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind. 

My contribution (my own projects): * Debenu Quick PDF Library - UDF * Debenu PDF Viewer SDK - UDF * Acrobat Reader - ActiveX Viewer * UDF for PDFCreator v1.x.x * XZip - UDF * AppCompatFlags UDF * CrowdinAPI UDF * _WinMergeCompare2Files() * _JavaExceptionAdd() * _IsBeta() * Writing DPI Awareness App - workaround * _AutoIt_RequiredVersion() * Chilkatsoft.au3 UDF * TeamViewer.au3 UDF * JavaManagement UDF * VIES over SOAP * WinSCP UDF * GHAPI UDF - modest begining - comunication with GitHub REST API * ErrorLog.au3 UDF - A logging Library * Include Dependency Tree (Tool for analyzing script relations) * Show_Macro_Values.au3 *

 

My contribution to others projects or UDF based on  others projects: * _sql.au3 UDF  * POP3.au3 UDF *  RTF Printer - UDF * XML.au3 UDF * ADO.au3 UDF * SMTP Mailer UDF * Dual Monitor resolution detection * * 2GUI on Dual Monitor System * _SciLexer.au3 UDF * SciTE - Lexer for console pane * 

Useful links: * Forum Rules * Forum etiquette *  Forum Information and FAQs * How to post code on the forum * AutoIt Online Documentation * AutoIt Online Beta Documentation * SciTE4AutoIt3 getting started * Convert text blocks to AutoIt code * Games made in Autoit * Programming related sites * Polish AutoIt Tutorial * DllCall Code Generator * 

Wiki: * Expand your knowledge - AutoIt Wiki * Collection of User Defined Functions * How to use HelpFile * Good coding practices in AutoIt * 

OpenOffice/LibreOffice/XLS Related: WriterDemo.au3 * XLS/MDB from scratch with ADOX

IE Related:  * How to use IE.au3  UDF with  AutoIt v3.3.14.x * Why isn't Autoit able to click a Javascript Dialog? * Clicking javascript button with no ID * IE document >> save as MHT file * IETab Switcher (by LarsJ ) * HTML Entities * _IEquerySelectorAll() (by uncommon) * IE in TaskScheduler * IE Embedded Control Versioning (use IE9+ and HTML5 in a GUI) * PDF Related: * How to get reference to PDF object embeded in IE * IE on Windows 11 * 

I encourage you to read: * Global Vars * Best Coding Practices * Please explain code used in Help file for several File functions * OOP-like approach in AutoIt * UDF-Spec Questions *  EXAMPLE: How To Catch ConsoleWrite() output to a file or to CMD *

I also encourage you to check awesome @trancexx code:  * Create COM objects from modules without any demand on user to register anything. * Another COM object registering stuff * OnHungApp handler * Avoid "AutoIt Error" message box in unknown errors  * HTML editor * 

winhttp.au3 related : * https://www.autoitscript.com/forum/topic/206771-winhttpau3-download-problem-youre-speaking-plain-http-to-an-ssl-enabled-server-port/

"Homo sum; humani nil a me alienum puto" - Publius Terentius Afer
"Program are meant to be read by humans and only incidentally for computers and execute" - Donald Knuth, "The Art of Computer Programming"
:naughty:  :ranting:, be  :) and       \\//_.

Anticipating Errors :  "Any program that accepts data from a user must include code to validate that data before sending it to the data store. You cannot rely on the data store, ...., or even your programming language to notify you of problems. You must check every byte entered by your users, making sure that data is the correct type for its field and that required fields are not empty."

Signature last update: 2023-04-24

Link to comment
Share on other sites
mLipok Universalist

mLipok

Posted
Posted

Added here:
https://www.autoitscript.com/wiki/User_Defined_Functions#OpenOffice.2FLibreOffice

 

Signature beginning:
* Please remember: "AutoIt"..... *  Wondering who uses AutoIt and what it can be used for ? * Forum Rules *
* ADO.au3 UDF * POP3.au3 UDF * XML.au3 UDF * IE on Windows 11 * How to ask ChatGPT for AutoIt Code * for other useful stuff click the following button:

Spoiler

Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind. 

My contribution (my own projects): * Debenu Quick PDF Library - UDF * Debenu PDF Viewer SDK - UDF * Acrobat Reader - ActiveX Viewer * UDF for PDFCreator v1.x.x * XZip - UDF * AppCompatFlags UDF * CrowdinAPI UDF * _WinMergeCompare2Files() * _JavaExceptionAdd() * _IsBeta() * Writing DPI Awareness App - workaround * _AutoIt_RequiredVersion() * Chilkatsoft.au3 UDF * TeamViewer.au3 UDF * JavaManagement UDF * VIES over SOAP * WinSCP UDF * GHAPI UDF - modest begining - comunication with GitHub REST API * ErrorLog.au3 UDF - A logging Library * Include Dependency Tree (Tool for analyzing script relations) * Show_Macro_Values.au3 *

 

My contribution to others projects or UDF based on  others projects: * _sql.au3 UDF  * POP3.au3 UDF *  RTF Printer - UDF * XML.au3 UDF * ADO.au3 UDF * SMTP Mailer UDF * Dual Monitor resolution detection * * 2GUI on Dual Monitor System * _SciLexer.au3 UDF * SciTE - Lexer for console pane * 

Useful links: * Forum Rules * Forum etiquette *  Forum Information and FAQs * How to post code on the forum * AutoIt Online Documentation * AutoIt Online Beta Documentation * SciTE4AutoIt3 getting started * Convert text blocks to AutoIt code * Games made in Autoit * Programming related sites * Polish AutoIt Tutorial * DllCall Code Generator * 

Wiki: * Expand your knowledge - AutoIt Wiki * Collection of User Defined Functions * How to use HelpFile * Good coding practices in AutoIt * 

OpenOffice/LibreOffice/XLS Related: WriterDemo.au3 * XLS/MDB from scratch with ADOX

IE Related:  * How to use IE.au3  UDF with  AutoIt v3.3.14.x * Why isn't Autoit able to click a Javascript Dialog? * Clicking javascript button with no ID * IE document >> save as MHT file * IETab Switcher (by LarsJ ) * HTML Entities * _IEquerySelectorAll() (by uncommon) * IE in TaskScheduler * IE Embedded Control Versioning (use IE9+ and HTML5 in a GUI) * PDF Related: * How to get reference to PDF object embeded in IE * IE on Windows 11 * 

I encourage you to read: * Global Vars * Best Coding Practices * Please explain code used in Help file for several File functions * OOP-like approach in AutoIt * UDF-Spec Questions *  EXAMPLE: How To Catch ConsoleWrite() output to a file or to CMD *

I also encourage you to check awesome @trancexx code:  * Create COM objects from modules without any demand on user to register anything. * Another COM object registering stuff * OnHungApp handler * Avoid "AutoIt Error" message box in unknown errors  * HTML editor * 

winhttp.au3 related : * https://www.autoitscript.com/forum/topic/206771-winhttpau3-download-problem-youre-speaking-plain-http-to-an-ssl-enabled-server-port/

"Homo sum; humani nil a me alienum puto" - Publius Terentius Afer
"Program are meant to be read by humans and only incidentally for computers and execute" - Donald Knuth, "The Art of Computer Programming"
:naughty:  :ranting:, be  :) and       \\//_.

Anticipating Errors :  "Any program that accepts data from a user must include code to validate that data before sending it to the data store. You cannot rely on the data store, ...., or even your programming language to notify you of problems. You must check every byte entered by your users, making sure that data is the correct type for its field and that required fields are not empty."

Signature last update: 2023-04-24

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share
Go to topic listing
×
×
  • Create New...