class FindAndReplace:
def __init__(self, writerUnoObjs, askEach=True):
self.unoObjs = writerUnoObjs
self.msgboxFour = FourButtonDialog(writerUnoObjs)
self.askEach = askEach
self.selsCount = 0
def replace(self, oldString, newString):
changesMade = 0
search = self.unoObjs.document.createSearchDescriptor()
search.SearchString = oldString
search.SearchAll = True
search.SearchWords = True
search.SearchCaseSensitive = False
selsFound = self.unoObjs.document.findAll(search)
self.selsCount = selsFound.getCount()
if selsFound.getCount() == 0:
logger.debug("Did not find anything.")
return changesMade
for selIndex, oSel in enumerate(iteruno.byIndex(selsFound)):
logger.debug("Found selection %s", selIndex)
if self.askEach:
self.unoObjs.viewcursor.gotoRange(oSel.getStart(), False)
self.unoObjs.viewcursor.gotoRange(oSel.getEnd(), True)
result = self.msgboxFour.display(
"Make this change? (%s -> %s)", oldString, newString)
if result == "yes":
# keep going
pass
elif result == "no":
continue
elif result == "yesToAll":
self.askEach = False
else:
raise exceptions.UserInterrupt()
self.unoObjs.viewcursor.goRight(0, False) # deselect
oTextCursTmp = oSel.getText().createTextCursorByRange(oSel)
changeString(oTextCursTmp, newString)
changesMade += 1
return changesMade
class WordAsker:
"""Handles a particular word according to user feedback."""
def __init__(self, unoObjs, goodList):
self.unoObjs = unoObjs
self.goodList = goodList
self.dlgReplace = None # type spellreplace.DlgSpellingReplace
self.msgboxFour = FourButtonDialog(self.unoObjs)
self.rangeJumper = None
self.config = None
self.wordsToIgnore = set()
self.askEach = True
self.punctBefore = ""
self.punctAfter = ""
def setConfig(self, newConfig):
"""Param should be of type CheckerSettings."""
self.config = newConfig
def handleWord(self, wordText, tokens, wordTokenNum, rangeJumper):
"""Returns True if a change was made."""
self.rangeJumper = rangeJumper
self.separatePunct(tokens[wordTokenNum])
wordText = normalize(self.config.normForm, wordText)
if self.config.whichTask == 'ApplyCorrections':
return self.applyCorrection(wordText)
else:
return self.checkSpelling(
wordText, getContext(tokens, wordTokenNum))
def checkSpelling(self, wordText, context):
suggestList = self.goodList.suggestions.getSuggestions(wordText)
if not self.config.matchCase:
## Suggest only words of the same case as the word found.
# Non-roman characters will not be changed.
firstChar = wordText[:1]
if firstChar.isupper():
suggestList = util.uniqueList(
[s.capitalize() for s in suggestList])
elif firstChar.islower():
suggestList = util.uniqueList(
[s.lower() for s in suggestList])
if not self.dlgReplace:
self.dlgReplace = DlgSpellingReplace(self.unoObjs)
self.dlgReplace.makeDlg()
self.dlgReplace.setContents(wordText, suggestList, context)
self.dlgReplace.doExecute()
action, changeTo = self.dlgReplace.getResults()
if action == 'Ignore':
# just keep going
return False
elif action == 'IgnoreAll':
self.wordsToIgnore.add(self.goodList.firstLower(wordText))
return False
elif action == 'Change':
self.rangeJumper.changeString(self.addPunct(changeTo))
return True
elif action == 'ChangeAll':
self.rangeJumper.changeString(self.addPunct(changeTo))
replacer = FindAndReplace(self.unoObjs, False)
replacer.replace(wordText, changeTo)
return True
elif action == 'Add':
self.goodList.add(self.removeAffixes(wordText))
return False
# user probably pressed Close or x'd out of the dialog
raise exceptions.UserInterrupt()
def applyCorrection(self, wordText):
"""Returns True if a change was made."""
newWord = self.goodList.changeDict[self.goodList.firstLower(wordText)]
if self.askEach:
result = self.msgboxFour.display(
"Make this change? (%s -> %s)", wordText, newWord)
if result == 'yes':
pass
elif result == 'no':
return False
elif result == 'yesToAll':
self.askEach = False
else:
raise exceptions.UserInterrupt()
self.rangeJumper.changeString(self.addPunct(newWord))
return True
def separatePunct(self, wordWithPunct):
"""Separate punctuation from a word.
Sets self.punctBefore and self.punctAfter.
"""
withoutLPunct = wordWithPunct.lstrip(self.config.punctuation)
withoutRPunct = wordWithPunct.rstrip(self.config.punctuation)
# These will just be "" if the word does not have punctuation.
self.punctBefore = wordWithPunct[:-len(withoutLPunct)]
self.punctAfter = wordWithPunct[len(withoutRPunct):]
def addPunct(self, word):
"""Add to a word whatever punctuation was found."""
return self.punctBefore + word + self.punctAfter
def removeAffixes(self, wordText):
for prefix in self.config.prefixes:
if wordText.startswith(prefix):
wordText = wordText[len(prefix):]
for suffix in self.config.suffixes:
if wordText.endswith(suffix):
wordText = wordText[:-len(suffix)]
return wordText
def cleanup(self):
if self.dlgReplace:
self.dlgReplace.doDispose()
# reset in case we use this class again later
self.askEach = True
class TextChanger:
def __init__(self, unoObjs, progressBar, settings):
self.unoObjs = unoObjs
self.progressBar = progressBar
self.msgboxFour = FourButtonDialog(unoObjs)
self.secCall = None
self.styleType = ""
self.newStyleName = ""
self.newFont = None
self.numChanges = 0
self.numStyleChanges = 0
self.selsCount = 0
self.askEach = False
self.colorize = settings.colorize
def setConverterCall(self, secCall):
self.secCall = secCall
def setStyleToChange(self, styleType, styleName):
self.styleType = styleType
self.newStyleName = styleName
def setFontToChange(self, fontDef):
""":arg fontDef: type styles.FontDefStruct"""
self.styleType = "FontOnly"
self.newFont = fontDef
def doChanges(self, ranges, askEach):
"""
:arg ranges: list of search.TxtRange objects
:returns: number of changes made
"""
logger.debug(util.funcName('begin'))
self.numChanges = 0
self.numStyleChanges = 0
self.askEach = askEach
if self.unoObjs.viewcursor:
originalRange = self.unoObjs.viewcursor.getStart()
rangeLastChanged = None
progressRange = ProgressRange(
start=40, stop=90, ops=len(ranges), pbar=self.progressBar)
rangeNum = 1
for txtRange in ranges:
if self.colorize:
colorize_range(txtRange.sel)
changed = False
try:
changed = self.changeTextRange(txtRange)
except (exceptions.UserInterrupt,
exceptions.FileAccessError) as exc:
logger.exception(exc)
return self.numChanges, self.numStyleChanges
if changed:
logger.debug("Converted.")
try:
rangeLastChanged = txtRange.sel.getStart()
except (RuntimeException, IllegalArgumentException):
# Just give up.
logger.warning("Failed to get text range.")
continue
progressRange.update(rangeNum)
rangeNum += 1
if self.unoObjs.viewcursor:
try:
if rangeLastChanged is None:
self.unoObjs.viewcursor.gotoRange(originalRange, False)
else:
self.unoObjs.viewcursor.gotoRange(rangeLastChanged, False)
except (RuntimeException, IllegalArgumentException):
# Just give up; it's not essential.
logger.warning("Failed to go to text range.")
logger.debug(util.funcName('end'))
return self.numChanges, self.numStyleChanges
def changeTextRange(self, txtRange):
logger.debug(util.funcName('begin'))
oSel = txtRange.sel
try:
oCursor = oSel.getText().createTextCursorByRange(oSel)
except (RuntimeException, IllegalArgumentException):
logger.warning("Failed to go to text range.")
return
logger.debug(u"String = '%r'", oCursor.getString())
if self.askEach:
if self.unoObjs.viewcursor:
self.unoObjs.viewcursor.gotoRange(oSel.getStart(), False)
self.unoObjs.viewcursor.gotoRange(oSel.getEnd(), True) # select
else:
self.unoObjs.controller.select(oSel)
result = self.msgboxFour.display("Make this change?")
if not self.unoObjs.viewcursor:
self.unoObjs.controller.select(None)
if result == "yes":
# keep going
pass
elif result == "no":
return False
elif result == "yesToAll":
self.askEach = False
else:
raise exceptions.UserInterrupt()
return self.convertString(oCursor)
def convertString(self, oCurs):
"""Here is where the call to SEC Converters is actually done.
It calls an OOo C++ component which calls the SEC dll file.
Then it makes the change in Writer.
Also sets the new style.
Returns True if a change is made.
Throws an exception if there is a problem with conversion.
"""
inValue = oCurs.getString()
## Get the converted value
changedText = False
if self.secCall is not None:
outValue = self.secCall.convert(inValue)
changedText = True
if outValue == inValue:
changedText = False
outValue = prepareNewlines(outValue)
if outValue == inValue:
changedText = False
logger.debug("converted text '%s'", outValue)
if self.styleType == "ParaStyleName":
self.changeParaStyle(oCurs)
elif self.styleType == "CharStyleName":
self.changeCharStyle(oCurs)
elif self.styleType == "FontOnly":
self.changeFont(oCurs)
if not changedText:
return False
changeString(oCurs, outValue)
self.numChanges += 1
return True
def changeParaStyle(self, oCurs):
"""Goes to the paragraph and sets the style.
Changes any directly formatted font name and size to the default.
"""
logger.debug(util.funcName('begin'))
oCursDbg = oCurs.getText().createTextCursorByRange(oCurs.getStart())
oCursDbg.gotoRange(oCurs.getEnd(), True)
logger.debug("oCursText = '%s'", oCursDbg.getString())
firstCellName = ""
# enumerate current paragraph
for oTextElem in iteruno.byEnum(oCurs):
logger.debug("oTextElem %s", oTextElem.getString())
if oTextElem.TextTable:
curCurs = oTextElem.getText().createTextCursorByRange(
oTextElem.getStart())
if curCurs is None:
# This happens after the first cell; I don't know why.
curCellName = "none"
else:
curCurs.goRight(0, False)
curCellName = curCurs.Cell.CellName
logger.debug("cell %s", curCellName)
if firstCellName == "":
firstCellName = curCellName
elif curCellName != firstCellName:
# Somehow we've gotten out of the cell
logger.debug(
"moved out of %s to %s", firstCellName, curCellName)
break
if oTextElem.supportsService("com.sun.star.text.Paragraph"):
curStyleName = oTextElem.getPropertyValue(self.styleType)
if curStyleName != self.newStyleName:
logger.debug("Setting style %s", self.newStyleName)
oTextElem.setPropertyValue(
self.styleType, self.newStyleName)
self.numStyleChanges += 1
for oTextPortion in iteruno.byEnum(oTextElem):
for propName in ("CharFontName", "CharHeight"):
if (oTextPortion.getPropertyState(propName) ==
DIRECT_VALUE):
oTextPortion.setPropertyToDefault(propName)
logger.debug("setToDefault %s", propName)
self.clearFont(oCurs)
logger.debug(util.funcName('end'))
def changeCharStyle(self, oCurs):
"""Change character style."""
curStyleName = oCurs.getPropertyValue(self.styleType)
if curStyleName != self.newStyleName:
logger.debug(
"Setting style %s from %s", self.newStyleName, curStyleName)
oCurs.setPropertyValue(self.styleType, self.newStyleName)
self.numStyleChanges += 1
self.clearFont(oCurs)
def clearFont(self, oCurs):
"""Setting a character or paragraph style doesn't clear font
formatting. It just overrides it. This can be a problem when changing
encoding using a font as the scope, because it will still find the
font even after the conversion is done.
To make sure this doesn't happen, reset the font when changing styles.
"""
self.newFont = styles.FontDefStruct()
self.changeFont(oCurs)
def changeFont(self, oCurs):
for propSuffix in ['', 'Complex', 'Asian']:
oCurs.setPropertyToDefault('CharFontName' + propSuffix)
oCurs.setPropertyToDefault('CharHeight' + propSuffix)
propSuffix = self.newFont.fontType
if propSuffix == 'Western':
propSuffix = ''
if self.newFont.fontName:
self.setCursProp(
oCurs, 'CharFontName' + propSuffix, self.newFont.fontName)
if self.newFont.fontSize.isSpecified():
self.newFont.fontSize.setPropSuffix(propSuffix)
self.newFont.fontSize.changeElemProp(oCurs)
def setCursProp(self, oCurs, propName, newVal):
curVal = oCurs.getPropertyValue(propName)
if curVal != newVal:
logger.debug("Setting %s from %s to %s", propName, curVal, newVal)
oCurs.setPropertyValue(propName, newVal)
self.numStyleChanges += 1