Skip to content

Commit

Permalink
Major refactoring.
Browse files Browse the repository at this point in the history
  • Loading branch information
@rmcpantoja
rmcpantoja committed Apr 28, 2024
1 parent 204e7e2 commit 3d0f8b9
Show file tree
Hide file tree
Showing 6 changed files with 349 additions and 319 deletions.
1 change: 1 addition & 0 deletions addon/doc/es/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ Si quieres ayudar a mejorar este complemento, puedes enviar un correo a `angelit

* Agregado: Se ha reintroducido la compatibilidad con NVDA 2024.1, agregando compatibilidad con el modo de voz en petición para alternar num2words en tiempo real.
* Corregido: errores con decimales no válidos. Ahora, por ejemplo, cuando num2words en tiempo real está activado, NVDA no se quedará callado ni mostrará un error en el log en estos casos.
* Se hizo una refactorización de código a todo el complemento. De esta forma, puede ser más legible y organizado para los contribuyentes.

## 0.4.1

Expand Down
332 changes: 13 additions & 319 deletions addon/globalPlugins/n2w/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,23 @@
# Author: Mateo Cedillo
# imports:
import globalPluginHandler
from typing import Optional
import globalCommands
from scriptHandler import script
import inputCore
import speech
from speech.speech import getCurrentLanguage, processText
from speech.commands import LangChangeCommand, CharacterModeCommand
from speech.types import SpeechSequence
from speech.priorities import Spri
from speech import manager
from logHandler import log
from speech.speech import getCurrentLanguage
from speech.types import SpeechSequence
import config
import addonHandler
import tones
import ui
from typing import Optional
import globalVars
import os
import sys
sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'num2words'))
import num2words
from .tools.datetime2words import convert_date, convert_hour
import re
import gui, wx
import gui
import wx
from gui import settingsDialogs
from .conversion_UI import ConversionDialog
from . import nvda_implementation
from .options import num2words_Settings

# default params and definitions:
speak_orig = None # speak object if num2words is disabled.
realtime = False # this determines whether or not to use the add-on's realtime mode while NVDA is speaking. This can be configured using the gesture set or the num2words settings panel.
Expand All @@ -49,308 +40,11 @@
}
config.conf.spec["num2words"] = confspec

def convert_num_to_words(
utterance: str,
language: str,
to: Optional[str] = 'cardinal',
ordinal: Optional[bool] = False,
currency: Optional[str] = "EUR",
**kwargs
):
match = re.findall(r'[\d./]+', utterance)
if len(match) > 0:
if len(re.findall(r'\d{28,}', utterance)) > 0:
tones.beep(1200, 100)
utterance =_(
# Translators: Error message when the number is too big.
_("The number is too big! twenty seven numbers maximum")
)
else:
# apply some text replacements to avoid decimal errors:
utterance = utterance.replace("..", ".") # > 2 dots is considered a decimal error.
if not to == "currency":
utterance = ' '.join([num2words.num2words(m, ordinal=ordinal, lang=language, to=to) if m.replace('.', '').replace('/', '').isdigit() else m for m in re.split(r'([\d./]+)', utterance)])
else:
utterance = ' '.join([num2words.num2words(m, ordinal=ordinal, lang=language, to=to, currency=currency) if m.replace('.', '').replace('/', '').isdigit() else m for m in re.split(r'([\d./]+)', utterance)])

if utterance and not utterance[0].isupper():
utterance = utterance.capitalize()
return utterance

# error message when language isn't supported:
def _lang_not_supported_MSG():
wx.MessageBox(
# Translators: Error message if the language is not supported by num2words.
_("The language set in the speech synthesis is not supported by the num2words library. If you want to suggest or add this language, you can do it through the library repository: https://github.com/savoirfairelinux/num2words"),
# Translators: Title of the error message.
_("Error"),
wx.ICON_ERROR
)

#taken from num2words/num2words/__init__.py
def check_language(lang: str):
if lang not in num2words.CONVERTER_CLASSES:
# ... and then try only the first 2 letters
lang = lang[:2]
if lang not in num2words.CONVERTER_CLASSES:
return False
def switch_speak(speechSequence: SpeechSequence, priority: Spri = None):
if realtime:
return nvda_implementation.speak_mod(speechSequence=speechSequence, priority=priority)
else:
return lang

# function modified from NVDA source. (speech/speech.py)
def speak_mod(speechSequence: SpeechSequence,
priority: Spri = None
):
global realtime
if not realtime:
return speak_orig(speechSequence=speechSequence, priority=priority)
import speechViewer
if speechViewer.isActive:
speechViewer.appendSpeechSequence(speechSequence)
autoLanguageSwitching=config.conf['speech']['autoLanguageSwitching']
autoDialectSwitching=config.conf['speech']['autoDialectSwitching']
curLanguage=defaultLanguage=getCurrentLanguage()
prevLanguage=None
defaultLanguageRoot=defaultLanguage.split('_')[0]
converted_speechSequence=[]
for item in speechSequence:
if isinstance(item,LangChangeCommand):
if not autoLanguageSwitching: continue
curLanguage=item.lang
if not curLanguage or (not autoDialectSwitching and curLanguage.split('_')[0]==defaultLanguageRoot):
curLanguage=defaultLanguage
elif isinstance(item,str):
if autoLanguageSwitching and curLanguage!=prevLanguage:
converted_speechSequence.append(LangChangeCommand(curLanguage))
prevLanguage=curLanguage
# Aplying number to words to synthesizer language:
new_item = convert_num_to_words(utterance=item, language=curLanguage)
# for testing:
#new_item = convert_num_to_words(utterance=item, language="en")
converted_speechSequence.append(new_item)
else:
converted_speechSequence.append(item)
inputCore.logTimeSinceInput()
log.io("Speaking %r" % converted_speechSequence)
curLanguage=defaultLanguage
for index in range(len(converted_speechSequence)):
item=speechSequence[index]
if autoLanguageSwitching and isinstance(item,LangChangeCommand):
curLanguage=item.lang
speak_orig(speechSequence = converted_speechSequence, priority = priority)

class ConversionDialog(wx.Dialog):
def __init__(self, parent):
super(ConversionDialog, self).__init__(
parent=parent,
# Translators: Name of the conversion dialog.
title=_("Convert number to words")
)
# declare:
self.use_ordinal_only=False
self.mode=0
self.currency = "EUR"
self.thisLanguageHasCurrencies = False
self.language = check_language(getCurrentLanguage()) # based on the synthesizer language
self.currencies = list(num2words.CONVERTER_CLASSES[self.language].CURRENCY_FORMS.keys())
if not self.currencies:
self.currencies = [
# Translators: message to inform the user that there is no type of currency to convert with this language.
_("There are no currencies to convert for this language. Using default.")
]
else:
self.thisLanguageHasCurrencies = True
self.write_label = wx.StaticText(
self,
# Translators: Label for the input box for the conversion.
label="&"+_("Write something here, example: 3 free throws")
)

self.input_text = wx.TextCtrl(self)
self.convert = wx.Button(
self,
# Translators: Label for the conversion button.
label="&"+_("Convert")
)
self.cancel = wx.Button(
self,
# Translators: Label for the button to cancel the conversion.
label=_("Cancel")
)
self.ordinal = wx.CheckBox(
self,
# Translators: label for the checkbox to convert to ordinals.
label=_("Ordinal mode")
)
self.conversion_label = wx.StaticText(
self,
# Translators: label for the combo box to choose the conversion mode.
label=_("Choose conversion &mode:")
)
self.conversion_mode = wx.Choice(
self,
# Translators: Options to choose the conversion mode that numbers to words supports. There are seven modes:
choices=[
_("None"),
_("cardinal"),
_("Ordinal"),
_("Ordinal number"),
_("Date"),
_("Hour"),
_("Year"),
_("Currency")
]
)
self.currencies_label = wx.StaticText(
self,
# Translators: label for the currency selection combo box.
label=_("Select the currency to convert:")
)
self.select_currencies = wx.Choice(
self,
choices=self.currencies
)
sizer = wx.BoxSizer(wx.VERTICAL)
sizer.Add(self.write_label, 0, wx.ALL, 5)
sizer.Add(self.input_text, 0, wx.EXPAND|wx.ALL, 5)
hbox = wx.BoxSizer(wx.HORIZONTAL)
hbox.Add(self.conversion_label, 0, wx.ALIGN_CENTER_VERTICAL|wx.ALL, 5)
hbox.Add(self.conversion_mode, 0, wx.ALIGN_CENTER_VERTICAL|wx.ALL, 5)
hbox.Add(self.currencies_label, 0, wx.ALIGN_CENTER_VERTICAL|wx.ALL, 5)
hbox.Add(self.select_currencies, 0, wx.ALIGN_CENTER_VERTICAL|wx.ALL, 5)
sizer.Add(hbox, 0, wx.EXPAND|wx.ALL, 5)
sizer.Add(self.ordinal, 0, wx.ALL, 5)
sizer.Add(self.convert, 0, wx.ALIGN_CENTER|wx.ALL, 5)
sizer.Add(self.cancel, 0, wx.ALIGN_CENTER|wx.ALL, 5)
self.SetSizer(sizer)
self.Bind(wx.EVT_CHECKBOX, self.onOrdinal, self.ordinal)
self.Bind(wx.EVT_CHOICE, self.onConversion_mode, self.conversion_mode)
self.Bind(wx.EVT_CHOICE, self.onSelect_currencies, self.select_currencies)
self.Bind(wx.EVT_BUTTON, self.onConvert, self.convert)
self.Bind(wx.EVT_BUTTON, self.OnCancel, self.cancel)
self.Bind(wx.EVT_CHAR_HOOK, self.accel_keys)
# set default parametters:
self.conversion_mode.SetSelection(0)
if self.thisLanguageHasCurrencies:
self.select_currencies.SetSelection(0)
self.input_text.SetFocus()
# by default, disabling currency controls:
self.currencies_label.Disable()
self.select_currencies.Disable()
# set accelerator keys:
self.SetEscapeId(self.cancel.GetId())

def onOrdinal(self, event):
self.use_ordinal_only = event.IsChecked()
self.conversion_mode.Enable(not event.IsChecked())

def onConversion_mode(self, event):
self.mode = self.conversion_mode.GetSelection()
if self.mode == 7:
self.currencies_label.Enable()
self.select_currencies.Enable()
else:
self.currencies_label.Disable()
self.select_currencies.Disable()

def onSelect_currencies(self, event):
self.currency = self.select_currencies.GetStringSelection()

def onConvert(self, event):
words = None
to_convert = self.input_text.GetValue()
if not to_convert :
wx.MessageBox(
# Translators: Error message when there is nothing to convert.
_("there's nothing to convert"),
# Translators: Title of the error message.
_("Error"),
wx.ICON_ERROR
)
else:
# supported modes:
if self.mode == 0 or self.mode == 1:
conversion_type = "cardinal"
elif self.mode == 2:
conversion_type = "ordinal"
elif self.mode == 3:
conversion_type = "ordinal_num"
elif self.mode == 4:
conversion_type = "date" # custom mode
elif self.mode == 5:
conversion_type = "hour" # custom mode
elif self.mode == 6:
conversion_type = "year"
elif self.mode == 7:
conversion_type = "currency"
# convert:
if conversion_type == "date":
try:
words = convert_date(to_convert, 1, self.language)
words = convert_num_to_words(
utterance=words,
ordinal=self.use_ordinal_only,
language=self.language,
to="year"
)
except Exception as e:
wx.MessageBox(
# Translators: error message when it is an invalid date.
_(str(e)),
# Translators: Title of the error message.
_("Conversion error"),
wx.ICON_ERROR
)
elif conversion_type == "hour":
if ":" in to_convert:
try:
words = convert_hour(to_convert)
words = convert_num_to_words(
utterance=words,
ordinal=self.use_ordinal_only,
language=self.language,
to="cardinal"
)
except Exception as e:
wx.MessageBox(
# Translators: error message when the hour is invalid.
_(str(e)),
# Translators: Title of the error message.
_("Conversion error"),
wx.ICON_ERROR
)
else:
wx.MessageBox(
# Translators: Error message when a valid time is not given.
_("This is not a valid hour format"),
# Translators: Title of the error message.
_("Conversion error"),
wx.ICON_ERROR
)
else:
words = convert_num_to_words(
utterance=to_convert,
ordinal=self.use_ordinal_only,
language=self.language,
to=conversion_type,
currency=self.currency
)
if words is not None:
wx.MessageBox(
words,
# Translators: title of the conversion results dialog.
_("Conversion results")
)

def OnCancel(self, event):
self.Destroy()

def accel_keys(self, event):
keycode = event.GetKeyCode()
if keycode == wx.WXK_ESCAPE:
self.OnCancel(event)
else:
event.Skip()

class GlobalPlugin(globalPluginHandler.GlobalPlugin):
# Translators: Add-on category name.
Expand All @@ -361,15 +55,15 @@ def __init__(self):
# Add num2words category to the NVDA settings panel.
settingsDialogs.NVDASettingsDialog.categoryClasses.append(num2words_Settings)
# detect if language is supported:
if check_language(getCurrentLanguage()) == False:
if nvda_implementation.check_language(getCurrentLanguage()) == False:
wx.CallLater(500, _lang_not_supported_MSG)
return
else:
global speak_orig
# original object when is disabled:
speak_orig = speech._manager.speak
speak_orig = nvda_implementation.speak_orig
# replace the original speak object to the modified speak_mod func:
speech._manager.speak = speak_mod
speech._manager.speak = switch_speak
# If the config to enable num2words on startup is enabled...
if config.conf["num2words"]["enableOnStartup"]:
realtime = True
Expand Down
Loading

0 comments on commit 3d0f8b9

Please sign in to comment.