SPELL_CHECK_R1

[boyan]

SPELL_CHECK_R1

[boyan]

starting analysis

[boyan]

analysis finished (0.5d)

[boyanl]

The analysis is clear and sufficient for the task

[boyanl]

• Changes to SearchTextUtility
  • Modified the search function which seaches a String in an ImmText to accept additional parameters - whether we want to match only whole words and the word delimiters if we do want (needed for the spellcheck)
  • Other fixes to the search function - 1027 wasn't a prime number, and changed one variable to be long instead of int (caused overflows and erraneous behaviour at times)
  • Modified the other search functions to have variants returning the amount of found results instead of just boolean, and some to accept a wholeWords parameter as well

• Changes to ElementView and BookView
  • Added another overload of search (which returns the amount of results instead of just boolean, and accepts whether we want to search whole words only)

• Changes to TextFrameView
  • Modified showSearchMatch so that it selects the correct match when searching in a chain.
  • Added an abstract void getMisspelledWords(List<String> results), which fills results with the misspelled words in the text view.

• Add a new class MisspelledWordsPalette, which should store the list of misspelled words after a spell check, and contains the buttons for the operations too
  • Add classes for the buttons - SpellCheckButton, Replace(All)Button, Ignore(All)Button, AddToDictionaryButton, and in initHead add the buttons to the palette.
  • Add an inner class MisspelledItem extends ListPaletteItem, which is the type of item in the palette. Represents a misspelled word.
  • Add a method void setNearestSelected (int prevIndex) which sets a "next" selected item based on the previous selection index (assuming the item which was at the previous index was removed)
  • Add a field HotTextSearchMatch currentMatch which represents the SearchMatch in the text, corresponding to the current selection in the palette. Add getter and setter for the field.
  • Add a method int firstSelectedIndex() which returns the index of the first selected item in the palette.
  • Add a field Map<String, Set<Integer>> ignoreIndices, which represents the indices for each word which are ignored. (I.e. if we choose to ignore the first and third "abc" in the palette, ignoreIndices at "abc" will contain 0 and 2)
  • Add a field Set<String> ignoredWords which represents the ignored words for this session. (happens when we ignore a word with Ignore All)
  • Add an enum of EventIds for the palette.

• Add a new class SuggestionsPalette, which should store a list of suggestions for the correct spelling of a word. Filled when there is a selected word in the MisspelledWordsPalette
  • Add an inner class SuggestedItem extends ListPaletteItem, which is the type of item in the palette. Represents a suggestion for the correct spelling.

• Add a new class SpellCheckLogic which provides the logic for spell checking
  • Add an inner class HelperLogic which provides helper methods (mainly to reduce code duplication) ... I'm not going to describe them all
  • Add handlers for the events fired in the MisspelledWordsPalette and SuggestionsPalette classes
    • ON_SPELLCHECK - spell checks the whole book and adds the resultant list of misspelled words to the MispelledWordsPalette instance
    • ON_MISSPELLED_ITEM_SELECTED - performs a search on the text and selects the correct item (based on which item was selected/ignore list). Updates the currentMatch in MisspelledWordsPalette
    • ON_REPLACE - replaces the selected misspelled word with the selected suggested word and removes it from the palette
    • ON_REPLACE_ALL - replaces all occurenes of the selected misspelled word with the selected suggested word and removes them from the palette
    • ON_SUGGESTEM_ITEM_DOUBLE_CLICKED - handles double-clicking on a suggested item. Same as replace
    • ON_IGNORE_ONCE - updates the ignore indices for the selected word in MisspelledWordsPalette and removes it from the palette
    • ON_IGNORE_ALL - same as above but for all such words in the pallette. Also adds the word to the "ignored for this session" words (MisspelledWordsPalette.ignoredWords)
    • ON_ADD_TO_DICTIONARY - adds the selected misspelled word to the currently loaded dictionary

• Added icons for all buttons
• Known issues - there is still no underlining of misspelled words, and there is no option for dictionary selection.

The changes are in [9188]

[meddle]

• I suggest to delete the 'search' methods returning boolean and replace and in all places to use the new ones that return the number of the matches found (0 means no matches found).
• Is the 'getMisspelledWords' in it's right place, I think the spell-check functionality should have its own module. I mean the text should exist without spell-check.
  • My idea is the same and for the 'MisspelledWordsPalette', 'SpellCheckLogic' and the 'SuggestionsPalette' and all the classes and logic they use.
  • The module should be main.extra one.
  • All the demos and dictionaries should be in this module.

3.5p

[boyanl]

• Extract the spell check functionality in a new module - org.sophie2.extra.func.spellcheck
• Add a new processor for the underlining needs of spell-checking - UnderliningProcessor, which holds some intervals in a list and underlines them if necesary when processing the text.
  • Add a new CommonAttr to indicate that the character should be underlined as misspelled - CommonAttr.MISSPELLED
  • Modify HotSegmentLayout.draw to draw the underline for misspelled words.
  • Modify ImmTextInterval.intersect to return null when the 2 intervals don't intersect.
  • Add an extension point to TextFuncModule for TextProcessors
  • Add logic in HeadTextModel to load all the text processor extension points and add them to the model.
  • Changes to MisspelledWordsPalette
    • Add a new member to hold the misspelled intervals - Map<TextModel, List<ImmTextInterval>> misspelledIntervals, and boolean showIntervals to represent whether the underlines should be visible or not
    • Add a property which should update the intervals as the text models on the current page change - Prop<Void> misspelledIntervalsSync
    • Add a button for toggling on/off the underlines in text

• Known issues - the processor could possibly be slow when the underlining is enabled in a large text with a lot misspelled intervals (this is because of the way its options are updated - currently in the most naive way possible). There still is not an option for dictionary selection.

The changes are in [9217]

[boyanl]

The right changeset is [9220] (the previous one was missing the dictionaries and the demo)

[boyanl]

• Added some extra logic when handing IGNORE and IGNORE_ALL to remove the underlining when words are being ignored
• Added an extra parameter Set<String> ignoredWords to getMisspelledWords in SpellCheckUtility, HelperLogic.getMisspelledWords and the constructor of AccumulatingSpellCheckListener - the words who are ignored are not added to their results, instead of being removed when filling the palette.

[pap]

• Committed in [9241].
• MISSPELLED attribute - isn't it a LayoutAttr instead of CommontAttr?
• Define color of underlining somewhere(an attribute)?
• ImmTextInterval.intersect - if/for/switch statements without braces are forbidden.
• MisspelledWordsPalette - the components in the head should be in their own resource properties. Also the properties holding visual elements(buttons) may return null so it is unsafe to write myButton().get().swingComponent().get() - quite risky about NPEs.
• Don't put empty sortKeys - the buttons in the MisspelledWordsPalette.
• In ToggleUnderlineButton use AutoProperties to hold the different IconSets. This way they are cached you won't query the skin so often. Skin queries are relatively slow.
• When in a palette and searching for its brother(a palette in the same tab) use the method getPalette of the Tab class instead of findNearestElement. It's faster.
• JavaDoc is not properly formatted. Insert an empty line between the description of the method and its parameters. Put a dot at the end of the sentences of the JavaDoc.
• It is generally quite a bad idea to use fields with getters and setters inside ProObjects. You should use properties instead. The reason is that properties are tracked (that's the idea of pro-lib).
• There is fake JavaDoc

[meddle]

Closing all the tickets before M Y1