IndexOutOfBoundsException in RichText demo #449

clartaq · 2017-03-11T22:34:05Z

When changing the font of the entire contents of the demo editor pane, an IndexOutOfBounds exception is thrown in the "JavaFX Application Thread".

Steps to reproduce:

Start the RichText demo (from the pre-built jar or building in Gradle).
Paste the README.md file into the demo.
Select All (Ctrl-A)
Select a different [font size or font family from their respective ComboBox] (edited by Jordan)

Environment:

Windows 10 Pro, 64-bit
RichTextFX 0.6.10

java -version
java version "1.8.0_121"
Java(TM) SE Runtime Environment (build 1.8.0_121-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.121-b13, mixed mode)

The text was updated successfully, but these errors were encountered:

JordanMartinez · 2017-03-12T04:19:46Z

@clartaq Does this also occur using the 0.7-M3 release?

clartaq · 2017-03-12T14:01:13Z

The same error occurs when using 0.7-M3, whether I paste the contents of the 0.6.10 README.md or the 0.7-M3 version.

Also, using the new command in the demo to read a file produces an OutOfMemoryError when trying to load either of these files.

JordanMartinez · 2017-03-14T01:19:40Z

I can't reproduce the bug on my end in either of those versions.

Linux Mint 18.1
java version "1.8.0_121"
Java(TM) SE Runtime Environment (build 1.8.0_121-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.121-b13, mixed mode)

Also, using the new command in the demo to read a file produces an OutOfMemoryError when trying to load either of these files.

Could you create a new issue specifically for that and with more details as to the issue? I'm not sure which command to which you're referring.

JordanMartinez · 2017-03-14T01:21:40Z

Can someone else test this on a Windows environment?

alt-grr · 2017-03-14T10:04:18Z

I can confirm that bug, Windows 10 Enterprise, RichTextFX demo 0.6.10

Stacktrace:

Exception in thread "JavaFX Application Thread" java.lang.IndexOutOfBoundsException
        at com.sun.javafx.scene.control.ReadOnlyUnbackedObservableList.subList(ReadOnlyUnbackedObservableList.java:136)
        at javafx.collections.ListChangeListener$Change.getAddedSubList(ListChangeListener.java:242)
        at com.sun.javafx.scene.control.behavior.ListViewBehavior.lambda$new$177(ListViewBehavior.java:269)
        at javafx.collections.WeakListChangeListener.onChanged(WeakListChangeListener.java:88)
        at com.sun.javafx.collections.ListListenerHelper$Generic.fireValueChangedEvent(ListListenerHelper.java:329)
        at com.sun.javafx.collections.ListListenerHelper.fireValueChangedEvent(ListListenerHelper.java:73)
        at com.sun.javafx.scene.control.ReadOnlyUnbackedObservableList.callObservers(ReadOnlyUnbackedObservableList.java:75)
        at javafx.scene.control.MultipleSelectionModelBase.clearAndSelect(MultipleSelectionModelBase.java:378)
        at javafx.scene.control.ListView$ListViewBitSetSelectionModel.clearAndSelect(ListView.java:1403)
        at com.sun.javafx.scene.control.behavior.CellBehaviorBase.simpleSelect(CellBehaviorBase.java:256)
        at com.sun.javafx.scene.control.behavior.CellBehaviorBase.doSelect(CellBehaviorBase.java:220)
        at com.sun.javafx.scene.control.behavior.CellBehaviorBase.mousePressed(CellBehaviorBase.java:150)
        at com.sun.javafx.scene.control.skin.BehaviorSkinBase$1.handle(BehaviorSkinBase.java:95)
        at com.sun.javafx.scene.control.skin.BehaviorSkinBase$1.handle(BehaviorSkinBase.java:89)
        at com.sun.javafx.event.CompositeEventHandler$NormalEventHandlerRecord.handleBubblingEvent(CompositeEventHandler.java:218)
        at com.sun.javafx.event.CompositeEventHandler.dispatchBubblingEvent(CompositeEventHandler.java:80)
        at com.sun.javafx.event.EventHandlerManager.dispatchBubblingEvent(EventHandlerManager.java:238)
        at com.sun.javafx.event.EventHandlerManager.dispatchBubblingEvent(EventHandlerManager.java:191)
        at com.sun.javafx.event.CompositeEventDispatcher.dispatchBubblingEvent(CompositeEventDispatcher.java:59)
        at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:58)
        at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
        at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:56)
        at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
        at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:56)
        at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
        at com.sun.javafx.event.BasicEventDispatcher.dispatchEvent(BasicEventDispatcher.java:56)
        at com.sun.javafx.event.EventDispatchChainImpl.dispatchEvent(EventDispatchChainImpl.java:114)
        at com.sun.javafx.event.EventUtil.fireEventImpl(EventUtil.java:74)
        at com.sun.javafx.event.EventUtil.fireEvent(EventUtil.java:54)
        at javafx.event.Event.fireEvent(Event.java:198)
        at javafx.scene.Scene$MouseHandler.process(Scene.java:3757)
        at javafx.scene.Scene$MouseHandler.access$1500(Scene.java:3485)
        at javafx.scene.Scene.impl_processMouseEvent(Scene.java:1762)
        at javafx.scene.Scene$ScenePeerListener.mouseEvent(Scene.java:2494)
        at com.sun.javafx.tk.quantum.GlassViewEventHandler$MouseEventNotification.run(GlassViewEventHandler.java:380)
        at com.sun.javafx.tk.quantum.GlassViewEventHandler$MouseEventNotification.run(GlassViewEventHandler.java:294)
        at java.security.AccessController.doPrivileged(Native Method)
        at com.sun.javafx.tk.quantum.GlassViewEventHandler.lambda$handleMouseEvent$354(GlassViewEventHandler.java:416)
        at com.sun.javafx.tk.quantum.QuantumToolkit.runWithoutRenderLock(QuantumToolkit.java:389)
        at com.sun.javafx.tk.quantum.GlassViewEventHandler.handleMouseEvent(GlassViewEventHandler.java:415)
        at com.sun.glass.ui.View.handleMouseEvent(View.java:555)
        at com.sun.glass.ui.View.notifyMouse(View.java:937)
        at com.sun.glass.ui.win.WinApplication._runLoop(Native Method)
        at com.sun.glass.ui.win.WinApplication.lambda$null$148(WinApplication.java:191)
        at java.lang.Thread.run(Thread.java:745)

Searching for

"com.sun.javafx.scene.control.ReadOnlyUnbackedObservableList.subList(ReadOnlyUnbackedObservableList.java:136)"

on Google shows that this is not an uncommon error...

TomasMikula · 2017-03-14T16:21:56Z

JDK-8133228

clartaq · 2017-03-14T19:50:28Z

Also happens on Ubuntu.

Environment:

$ lsb_release -a
No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 16.04.2 LTS
Release:	16.04
Codename:	xenial

$ java -version
java version "1.8.0_121"
Java(TM) SE Runtime Environment (build 1.8.0_121-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.121-b13, mixed mode)

$ gradle -v

------------------------------------------------------------
Gradle 3.4.1
------------------------------------------------------------

Build time:   2017-03-03 19:45:41 UTC
Revision:     9eb76efdd3d034dc506c719dac2955efb5ff9a93

Groovy:       2.4.7
Ant:          Apache Ant(TM) version 1.9.6 compiled on June 29 2015
JVM:          1.8.0_121 (Oracle Corporation 25.121-b13)
OS:           Linux 4.4.0-66-generic amd64

JordanMartinez · 2017-03-15T01:16:40Z

Originally, I ran my test through my IDE which AFAIK delegates to Gradle, and never had the issue arise. The issue does appear on my end when I test it via a terminal.

clartaq · 2017-03-15T17:36:35Z

Ah, I never tried it through an IDE, just terminals.

JordanMartinez · 2017-03-15T18:56:57Z

I think this just proves once again that tests (and demos when debugging them) should be run via terminal, not IDE. I'm sure the error occurs even when run via the IDE; the resulting window just probably didn't display it.

JordanMartinez · 2017-03-18T03:42:52Z

Note: this issue also arises when familyCombo, the other comboBox, is used to select a different font family.

JordanMartinez · 2017-03-23T05:22:18Z

I'm labeling this as both a JDK bug and a regular bug because, although it's caused by the first, we could still rewrite the code to get around it.

Jugen · 2018-02-11T19:25:46Z

I'm getting an occasional IOOB exception being reported using RichTextFX 0.8.2 and decided to look into this bug as part of my research.

So as already noted this is both a JDK bug and a regular bug. The JDK bug only manifests when:

The text contains more than 1 paragraph,
The paragraph break is an empty line (i.e. has no white space character)
The selected text spans a paragraph boundary (i.e. crosses over from 1 paragraph into another), and
Either the font size or family is changed.

The exception is triggered by this line of code inside area.beingUpdatedProperty().addListener:

RichTextFX/richtextfx-demos/src/main/java/org/fxmisc/richtext/demo/richtext/RichText.java

Line 251 in f5f1748

sizeCombo.getSelectionModel().clearSelection();

or familyCombo.getSelectionModel().clearSelection(); depending on if size was changed (for the former) or font family (for the latter).

However this line of code being executed under these conditions is actually the regular bug. This is because it's only supposed to be executed if there is more than one font size (or family) in the selected text. Since the currently selected text has just been set to be a certain font size (or family) there should only be 1 font size (or family) style in the selection - but there isn't !?

The reason for this is because the new font style doesn't get set on or applied to paragraph breaks (i.e. the empty line between paragraphs) due to empty lines being skipped. The relevant line of code primarily responsible for this is:

RichTextFX/richtextfx/src/main/java/org/fxmisc/richtext/model/Paragraph.java

Lines 321 to 322 in f5f1748

    
           if(styleSpans.equals(getStyleSpans(from, from + len)) || length() == 0) { 
        
               return this;

As can be seen the paragraph is returned as is when the length is zero. If a space is added to the paragraph break then the exception "goes away" because now the style is being applied to the paragraph break. The solution I think is to replace the above code with something like:

if( length() == 0 ) {
   return new Paragraph<>(paragraphStyle, segmentOps, segments, (StyleSpans<S>) styleSpans);
}
if( styleSpans.equals( getStyleSpans( from, from + len ) ) )  { return this; }

JordanMartinez · 2018-02-12T17:45:25Z

Your proposed solution does resolve the issue. I'm not sure what the implications are (if any) as to what other issues this might produce since I'm not sure what the entire call stack is. Mind submitting another PR for that?

Jugen · 2018-02-13T16:58:06Z

So one implication is that it will cause this test to fail:

RichTextFX/richtextfx/src/test/java/org/fxmisc/richtext/model/ParagraphTest.java

Lines 23 to 36 in f5f1748

    
           // Relates to #345 and #505: calling `EditableStyledDocument::setStyleSpans` when the style spans 
        
           //  would style an empty paragraph would throw an exception 
        
           @Test 
        
           public void restylingEmptyParagraphViaStyleSpansWorks() { 
        
               TextOps<String, Boolean> segOps = SegmentOps.styledTextOps(); 
        
               Paragraph<Void, String, Boolean> p = new Paragraph<>(null, segOps, segOps.createEmptySeg(), false); 
        
               StyleSpansBuilder<Boolean> builder = new StyleSpansBuilder<>(); 
        
               builder.add(true, 2); 
        
               StyleSpans<Boolean> spans = builder.create(); 
        
               Paragraph<Void, String, Boolean> restyledP = p.restyle(0, spans); 
        
               assertEquals(p, restyledP); 
        
           }

specifically on line 35: assertEquals(p, restyledP);

Am I right in saying that if the test is to see whether an exception is thrown under these conditions then the assertion can be removed and the test will still be valid. If so then I can go ahead with the proposed change, modify the above test, and write another to check that styles are being applied to empty paragraphs.

JordanMartinez · 2018-02-13T17:15:40Z

mm....

I think the assertion should still hold... If one uses getTextStyleForInsertionAt
https://github.com/FXMisc/RichTextFX/blob/master/richtextfx/src/main/java/org/fxmisc/richtext/GenericStyledArea.java#L1117-L1124

... then I think the paragraph's style does matter and will produce different results.

Jugen · 2018-02-13T18:54:37Z

Sorry I don't follow your reasoning here ? The proposed change is going to change what getTextStyleForInsertionAt( pos ) returns if pos is the empty line.

Bear in mind that the current behavior is actually incorrect in that if you have selected multiple paragraphs and change the font size for example, and then decide to insert something at one of the paragraph breaks using getTextStyleForInsertionAt then if I'm not mistaken you will get the incorrect style returned. The font size in this case will be what it was before the change and not what that section of the document currently is.

At least that's how I understand it, or did you have something different in mind ?

JordanMartinez · 2018-02-14T05:25:41Z

Mm... Those are good points. I don't think I fully understood the entirety of the problem, hence, my response.

In response to your original question then, I think that would be a good modification to make.

JordanMartinez · 2018-02-14T16:08:14Z

Closed by #685

JordanMartinez changed the title ~~IndexOutOfBoundsException in RichText demo~~ [v0.6.10] IndexOutOfBoundsException in RichText demo Mar 12, 2017

JordanMartinez added the bug label Mar 18, 2017

JordanMartinez changed the title ~~[v0.6.10] IndexOutOfBoundsException in RichText demo~~ IndexOutOfBoundsException in RichText demo Mar 18, 2017

JordanMartinez mentioned this issue Mar 23, 2017

Exception (not sure why actually) #170

Closed

JordanMartinez added the JDK label Mar 23, 2017

JordanMartinez added demo and removed bug labels Mar 31, 2017

JordanMartinez added the bug label May 30, 2017

Jugen mentioned this issue Feb 14, 2018

Updated Paragraph to apply styles to empty paragraphs. #685

Merged

JordanMartinez closed this as completed Feb 14, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IndexOutOfBoundsException in RichText demo #449

IndexOutOfBoundsException in RichText demo #449

clartaq commented Mar 11, 2017 •

edited by JordanMartinez

Loading

JordanMartinez commented Mar 12, 2017

clartaq commented Mar 12, 2017

JordanMartinez commented Mar 14, 2017

JordanMartinez commented Mar 14, 2017

alt-grr commented Mar 14, 2017 •

edited

Loading

TomasMikula commented Mar 14, 2017

clartaq commented Mar 14, 2017

JordanMartinez commented Mar 15, 2017

clartaq commented Mar 15, 2017

JordanMartinez commented Mar 15, 2017

JordanMartinez commented Mar 18, 2017

JordanMartinez commented Mar 23, 2017

Jugen commented Feb 11, 2018 •

edited

Loading

JordanMartinez commented Feb 12, 2018

Jugen commented Feb 13, 2018

JordanMartinez commented Feb 13, 2018

Jugen commented Feb 13, 2018

JordanMartinez commented Feb 14, 2018

JordanMartinez commented Feb 14, 2018

IndexOutOfBoundsException in RichText demo #449

IndexOutOfBoundsException in RichText demo #449

Comments

clartaq commented Mar 11, 2017 • edited by JordanMartinez Loading

JordanMartinez commented Mar 12, 2017

clartaq commented Mar 12, 2017

JordanMartinez commented Mar 14, 2017

JordanMartinez commented Mar 14, 2017

alt-grr commented Mar 14, 2017 • edited Loading

TomasMikula commented Mar 14, 2017

clartaq commented Mar 14, 2017

JordanMartinez commented Mar 15, 2017

clartaq commented Mar 15, 2017

JordanMartinez commented Mar 15, 2017

JordanMartinez commented Mar 18, 2017

JordanMartinez commented Mar 23, 2017

Jugen commented Feb 11, 2018 • edited Loading

JordanMartinez commented Feb 12, 2018

Jugen commented Feb 13, 2018

JordanMartinez commented Feb 13, 2018

Jugen commented Feb 13, 2018

JordanMartinez commented Feb 14, 2018

JordanMartinez commented Feb 14, 2018

clartaq commented Mar 11, 2017 •

edited by JordanMartinez

Loading

alt-grr commented Mar 14, 2017 •

edited

Loading

Jugen commented Feb 11, 2018 •

edited

Loading