Issue 471 in pyglet: Exception when clearing text of FormattedDocument with IncrementalTextLayout

25 views
Skip to first unread message

codesite...@google.com

unread,
Mar 8, 2010, 10:52:06 PM3/8/10
to pyglet...@googlegroups.com
Status: New
Owner: ----

New issue 471 by euccastro: Exception when clearing text of
FormattedDocument with IncrementalTextLayout
http://code.google.com/p/pyglet/issues/detail?id=471

What steps will reproduce the problem?

(Sample REPL session pasted below.)

1. Create a FormattedDocument.

2. Create an IncrementalTextLayout initialized with this doc. I haven't
checked if the exception happens with other layouts, but it doesn't happen
with a document that has no layout registered to its events.

3. Insert or assign some formatted text to the document. More specifically,
you have to set some font style (font name, size, bold or italics).

4. Clear the doc text (either by assigning to the empty string or via
delete_text).


Paste in the traceback or error message:

Python 2.6.4 (r264:75706, Dec 7 2009, 18:43:55)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import pyglet
>>> doc = pyglet.text.document.FormattedDocument()
>>> layout = pyglet.text.layout.IncrementalTextLayout(doc, 100, 100)
>>> doc.insert_text(0, "hello", {'bold': True})
>>> doc.text = ""
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "pyglet/text/document.py", line 284, in _set_text
self.delete_text(0, len(self._text))
File "pyglet/text/document.py", line 445, in delete_text
self.dispatch_event('on_delete_text', start, end)
File "pyglet/event.py", line 355, in dispatch_event
if handler(*args):
File "pyglet/text/layout.py", line 1808, in on_delete_text
self._update()
File "pyglet/text/layout.py", line 1838, in _update
font = self.document.get_font(0, dpi=self._dpi)
File "pyglet/text/document.py", line 660, in get_font
return iter[position]
File "pyglet/text/document.py", line 719, in __getitem__
font_name, font_size, bold, italic = self.zip_iter[index]
File "pyglet/text/runlist.py", line 403, in __getitem__
return [i[index] for i in self.range_iterators]
File "pyglet/text/runlist.py", line 293, in __getitem__
self.start, self.end, self.value = self.next()
StopIteration


pyglet 1.1 with Python 2.5: Paste in the output of `python -m pyglet.info`
Other: Paste in the output of tools/gl_info.py (included in source distro):

I'm on Python 2.6, but I'm quite sure GL info is irrelevant to this bug, so
I paste the output of pyglet.info anyway:

------------------------------------------------------------------------------
sys.version: 2.6.4 (r264:75706, Dec 7 2009, 18:43:55)
[GCC 4.4.1]
sys.platform: linux2
os.getcwd(): /home/es/meu/src/pyglet-svn/tools

pyglet
------------------------------------------------------------------------------
pyglet.version: 1.2dev
pyglet.__file__: /usr/local/lib/python2.6/dist-packages/pyglet/__init__.pyc
pyglet.options['debug_trace_depth'] = 1
pyglet.options['font'] = ('gdiplus', 'win32')
pyglet.options['xsync'] = True
pyglet.options['debug_trace_flush'] = True
pyglet.options['debug_win32'] = False
pyglet.options['debug_gl_trace'] = False
pyglet.options['debug_x11'] = False
pyglet.options['shadow_window'] = True
pyglet.options['debug_font'] = False
pyglet.options['debug_media'] = False
pyglet.options['debug_trace'] = False
pyglet.options['xlib_fullscreen_override_redirect'] = False
pyglet.options['debug_lib'] = False
pyglet.options['graphics_vbo'] = True
pyglet.options['vsync'] = None
pyglet.options['debug_trace_args'] = False
pyglet.options['debug_gl'] = True
pyglet.options['debug_graphics_batch'] = False
pyglet.options['audio'] = ('directsound', 'pulse', 'openal', 'silent')
pyglet.options['debug_texture'] = False
pyglet.options['debug_gl_trace_args'] = False

pyglet.window
------------------------------------------------------------------------------
platform: <pyglet.window.Platform object at 0x7fd64272fed0>
display: <pyglet.canvas.xlib.XlibDisplay object at 0x1457250>
screens[0]: XlibScreen(display=<pyglet.canvas.xlib.XlibDisplay object at
0x1457250>, x=0, y=0, width=1440, height=900, xinerama=1)
screens[1]: XlibScreen(display=<pyglet.canvas.xlib.XlibDisplay object at
0x1457250>, x=1440, y=0, width=1280, height=1024, xinerama=1)
config['double_buffer'] = 1
config['stereo'] = 0
config['buffer_size'] = 32
config['aux_buffers'] = 4
config['sample_buffers'] = 0
config['samples'] = 0
config['red_size'] = 8
config['green_size'] = 8
config['blue_size'] = 8
config['alpha_size'] = 0
config['depth_size'] = 24
config['stencil_size'] = 0
config['accum_red_size'] = 16
config['accum_green_size'] = 16
config['accum_blue_size'] = 16
config['accum_alpha_size'] = 16
config['major_version'] = None
config['minor_version'] = None
config['forward_compatible'] = None
config['debug'] = None
context: XlibContextARB()

window.context._info
------------------------------------------------------------------------------
gl_info.get_version(): 2.1.2 NVIDIA 185.18.36
gl_info.get_vendor(): NVIDIA Corporation
gl_info.get_renderer(): GeForce 7600 GS/PCI/SSE2
gl_info.get_extensions():
GL_ARB_color_buffer_float
GL_ARB_depth_texture
GL_ARB_draw_buffers
GL_ARB_fragment_program
GL_ARB_fragment_program_shadow
GL_ARB_fragment_shader
GL_ARB_framebuffer_object
GL_ARB_half_float_pixel
GL_ARB_half_float_vertex
GL_ARB_imaging
GL_ARB_map_buffer_range
GL_ARB_multisample
GL_ARB_multitexture
GL_ARB_occlusion_query
GL_ARB_pixel_buffer_object
GL_ARB_point_parameters
GL_ARB_point_sprite
GL_ARB_shader_objects
GL_ARB_shading_language_100
GL_ARB_shadow
GL_ARB_texture_border_clamp
GL_ARB_texture_compression
GL_ARB_texture_cube_map
GL_ARB_texture_env_add
GL_ARB_texture_env_combine
GL_ARB_texture_env_dot3
GL_ARB_texture_float
GL_ARB_texture_mirrored_repeat
GL_ARB_texture_non_power_of_two
GL_ARB_texture_rectangle
GL_ARB_transpose_matrix
GL_ARB_vertex_array_object
GL_ARB_vertex_buffer_object
GL_ARB_vertex_program
GL_ARB_vertex_shader
GL_ARB_window_pos
GL_ATI_draw_buffers
GL_ATI_texture_float
GL_ATI_texture_mirror_once
GL_EXT_Cg_shader
GL_EXT_abgr
GL_EXT_bgra
GL_EXT_blend_color
GL_EXT_blend_equation_separate
GL_EXT_blend_func_separate
GL_EXT_blend_minmax
GL_EXT_blend_subtract
GL_EXT_compiled_vertex_array
GL_EXT_depth_bounds_test
GL_EXT_direct_state_access
GL_EXT_draw_range_elements
GL_EXT_fog_coord
GL_EXT_framebuffer_blit
GL_EXT_framebuffer_multisample
GL_EXT_framebuffer_object
GL_EXT_gpu_program_parameters
GL_EXT_multi_draw_arrays
GL_EXT_packed_depth_stencil
GL_EXT_packed_pixels
GL_EXT_pixel_buffer_object
GL_EXT_point_parameters
GL_EXT_provoking_vertex
GL_EXT_rescale_normal
GL_EXT_secondary_color
GL_EXT_separate_specular_color
GL_EXT_shadow_funcs
GL_EXT_stencil_two_side
GL_EXT_stencil_wrap
GL_EXT_texture3D
GL_EXT_texture_compression_s3tc
GL_EXT_texture_cube_map
GL_EXT_texture_edge_clamp
GL_EXT_texture_env_add
GL_EXT_texture_env_combine
GL_EXT_texture_env_dot3
GL_EXT_texture_filter_anisotropic
GL_EXT_texture_lod
GL_EXT_texture_lod_bias
GL_EXT_texture_mirror_clamp
GL_EXT_texture_object
GL_EXT_texture_sRGB
GL_EXT_texture_swizzle
GL_EXT_timer_query
GL_EXT_vertex_array
GL_EXT_vertex_array_bgra
GL_IBM_rasterpos_clip
GL_IBM_texture_mirrored_repeat
GL_KTX_buffer_region
GL_NVX_conditional_render
GL_NV_blend_square
GL_NV_copy_depth_to_color
GL_NV_depth_clamp
GL_NV_fence
GL_NV_float_buffer
GL_NV_fog_distance
GL_NV_fragment_program
GL_NV_fragment_program2
GL_NV_fragment_program_option
GL_NV_framebuffer_multisample_coverage
GL_NV_half_float
GL_NV_light_max_exponent
GL_NV_multisample_filter_hint
GL_NV_occlusion_query
GL_NV_packed_depth_stencil
GL_NV_pixel_data_range
GL_NV_point_sprite
GL_NV_primitive_restart
GL_NV_register_combiners
GL_NV_register_combiners2
GL_NV_texgen_reflection
GL_NV_texture_compression_vtc
GL_NV_texture_env_combine4
GL_NV_texture_expand_normal
GL_NV_texture_rectangle
GL_NV_texture_shader
GL_NV_texture_shader2
GL_NV_texture_shader3
GL_NV_vertex_array_range
GL_NV_vertex_array_range2
GL_NV_vertex_program
GL_NV_vertex_program1_1
GL_NV_vertex_program2
GL_NV_vertex_program2_option
GL_NV_vertex_program3
GL_S3_s3tc
GL_SGIS_generate_mipmap
GL_SGIS_texture_lod
GL_SGIX_depth_texture
GL_SGIX_shadow
GL_SUN_slice_accum

pyglet.gl.glu_info
------------------------------------------------------------------------------
glu_info.get_version(): 1.3
glu_info.get_extensions():
GLU_EXT_nurbs_tessellator
GLU_EXT_object_space_tess

pyglet.gl.glx_info
------------------------------------------------------------------------------
context.is_direct(): 1
glx_info.get_server_vendor(): NVIDIA Corporation
glx_info.get_server_version(): 1.3
glx_info.get_server_extensions():
GLX_EXT_visual_info
GLX_EXT_visual_rating
GLX_SGIX_fbconfig
GLX_SGIX_pbuffer
GLX_SGI_video_sync
GLX_SGI_swap_control
GLX_EXT_texture_from_pixmap
GLX_ARB_create_context
GLX_ARB_multisample
GLX_NV_float_buffer
GLX_ARB_fbconfig_float
glx_info.get_client_vendor(): NVIDIA Corporation
glx_info.get_client_version(): 1.4
glx_info.get_client_extensions():
GLX_ARB_get_proc_address
GLX_ARB_multisample
GLX_EXT_visual_info
GLX_EXT_visual_rating
GLX_EXT_import_context
GLX_SGI_video_sync
GLX_NV_swap_group
GLX_NV_video_out
GLX_SGIX_fbconfig
GLX_SGIX_pbuffer
GLX_SGI_swap_control
GLX_ARB_create_context
GLX_NV_float_buffer
GLX_ARB_fbconfig_float
GLX_EXT_fbconfig_packed_float
GLX_EXT_texture_from_pixmap
GLX_EXT_framebuffer_sRGB
GLX_NV_present_video
GLX_NV_multisample_coverage
glx_info.get_extensions():
GLX_EXT_visual_info
GLX_EXT_visual_rating
GLX_SGIX_fbconfig
GLX_SGIX_pbuffer
GLX_SGI_video_sync
GLX_SGI_swap_control
GLX_EXT_texture_from_pixmap
GLX_ARB_create_context
GLX_ARB_multisample
GLX_NV_float_buffer
GLX_ARB_fbconfig_float
GLX_ARB_get_proc_address

pyglet.media
------------------------------------------------------------------------------
audio driver: <pyglet.media.drivers.pulse.PulseAudioDriver object at
0x167ab90>

pyglet.media.avbin
------------------------------------------------------------------------------
AVbin not available.

pyglet.media.drivers.openal
------------------------------------------------------------------------------
OpenAL not available.

pyglet.input.wintab
------------------------------------------------------------------------------
WinTab not available.


Any additional info (platform/language/hardware) that may be relevant?

You can create the error more simply by just assigning a font style to an
empty doc, but that is arguably a degenerate usage. Now, you should be able
to delete text even if it is styled.

Bug happens both in SVN head (rev.2548) and in the official 1.1.4 release.

The reason why this only happens with an attached layout and a font tag set
is that the crash is triggered when the layout asks for the new font in the
event handler for the text change. Some ZipRunIterator that is used to find
the style is confused because the font style (bold, in this case) RunList
has only one Run with zero length.

From what I grasped of the code, it seems the RunList there is just as
intended and therefore it's the RunIterator.__getitem__ that should be more
open minded. The following patch just ignores the exception and lets
__getitem__ return the value of the last run, in that case. That fixes the
problem for my application, but I'm not sure if that's how you want to
handle it.

Index: pyglet/text/runlist.py
===================================================================
--- pyglet/text/runlist.py (revision 2548)
+++ pyglet/text/runlist.py (working copy)
@@ -289,8 +289,11 @@
self.start, self.end, self.value = self.next()

def __getitem__(self, index):
- while index >= self.end:
- self.start, self.end, self.value = self.next()
+ try:
+ while index >= self.end:
+ self.start, self.end, self.value = self.next()
+ except StopIteration:
+ pass
return self.value

def ranges(self, start, end):

Attachments:
emptydocfix.patch 620 bytes

--
You received this message because you are listed in the owner
or CC fields of this issue, or because you starred this issue.
You may adjust your issue notification preferences at:
http://code.google.com/hosting/settings

codesite...@google.com

unread,
Mar 8, 2010, 11:03:38 PM3/8/10
to pyglet...@googlegroups.com

Comment #1 on issue 471 by euccastro: Exception when clearing text of
FormattedDocument with IncrementalTextLayout
http://code.google.com/p/pyglet/issues/detail?id=471

Sorry, this is a duplicate of #241:

http://code.google.com/p/pyglet/issues/detail?id=241

That one is marked as fixed, though? I can reproduce it in fresh SVN head.

codesite...@google.com

unread,
Apr 27, 2010, 3:54:56 PM4/27/10
to pyglet...@googlegroups.com
Updates:
Status: Accepted
Owner: oresmus

Comment #2 on issue 471 by oresmus: Exception when clearing text of
FormattedDocument with IncrementalTextLayout
http://code.google.com/p/pyglet/issues/detail?id=471

After reviewing this and issue 241, I think we should not consider it a
duplicate of
issue 241, since that report may have lumped together several related
issues, of
which the original one was fixed and the others remain open. As I said
there, the 2
code samples in issue 241 comment 4, and the first code sample in issue 241
comment
5, can be considered duplicates of this bug, since they have similar
tracebacks and
all remain open (in 1.2dev, the hg head). But the tracebacks are not all
identical,
so whoever fixes this issue should still test those other 3 code samples
from issue
241 comments 4 and 5 to see if they are fixed as well.

I also reported a code sample which gets a very similar traceback in issue
429,
before I realized it belonged with this issue instead. Since this issue
doesn't yet
have its own code sample, here is an even simpler one derived from that one:

import pyglet
doc2 = pyglet.text.decode_attributed('{bold True}a')
layout = pyglet.text.layout.IncrementalTextLayout(doc2, 100, 10)
layout.document.delete_text(0, len(layout.document.text))

(This fits the pseudocode description of how to reproduce the problem in
this issue's
original report.)

I didn't yet analyze the code, so I don't yet have an opinion about whether
the
suggested patch is a correct fix.

I'll take ownership of this bug since I intend to try to fix it, but I
don't mind if
anyone else fixes it first! Also I am not sure whether it's best these days
to fix
bugs only in the head, or also in whatever the old "1.1-maintenance" branch
(from
svn) is now called (from which pyglet 1.1.4 was released). Whoever fixes
this should
make it clear in which branches they fixed it.

--
You received this message because you are listed in the owner
or CC fields of this issue, or because you starred this issue.
You may adjust your issue notification preferences at:
http://code.google.com/hosting/settings

--
You received this message because you are subscribed to the Google Groups "pyglet-issues" group.
To post to this group, send email to pyglet...@googlegroups.com.
To unsubscribe from this group, send email to pyglet-issue...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/pyglet-issues?hl=en.

codesite...@google.com

unread,
Apr 28, 2010, 12:39:50 AM4/28/10
to pyglet...@googlegroups.com

Comment #3 on issue 471 by oresmus: Exception when clearing text of
FormattedDocument with IncrementalTextLayout
http://code.google.com/p/pyglet/issues/detail?id=471

I've added test cases (almost all failing in 1.2dev) for the code samples
in this and
related issues; see tests/text/ISSUE_471.py and tests/text/EMPTY_BOLD.py.

codesite...@google.com

unread,
Apr 28, 2010, 12:44:54 AM4/28/10
to pyglet...@googlegroups.com

Comment #4 on issue 471 by oresmus: Exception when clearing text of
FormattedDocument with IncrementalTextLayout
http://code.google.com/p/pyglet/issues/detail?id=471

Oops, I didn't notice until now that the original report in this issue
*did* have an
actual code sample, as well as the pseudocode description. I'll add that to
tests/text/ISSUE_471.py too.

codesite...@google.com

unread,
Apr 28, 2010, 1:45:31 AM4/28/10
to pyglet...@googlegroups.com
Updates:
Status: Started

Comment #5 on issue 471 by oresmus: Exception when clearing text of
FormattedDocument with IncrementalTextLayout
http://code.google.com/p/pyglet/issues/detail?id=471

I fixed this in 1.2dev (all tests in ISSUE_471.py and EMPTY_BOLD.py now
pass), in
this revision:
http://code.google.com/p/pyglet/source/detail?r=64e3a450c83bd2245f047bb96fdacd79208d8b6a

I won't mark this issue as fixed until I discuss with pyglet-users whether
it also
ought to be fixed in the 1.1-maintenance branch (or whatever that's now
called). If
someone else knows the answer, feel free to just mark it as fixed and/or
port the
change to that branch.

codesite...@google.com

unread,
Apr 29, 2010, 3:27:11 PM4/29/10
to pyglet...@googlegroups.com
Updates:
Status: Fixed

Comment #6 on issue 471 by oresmus: Exception when clearing text of
FormattedDocument with IncrementalTextLayout
http://code.google.com/p/pyglet/issues/detail?id=471

After no reply in 1.5 days from pyglet-users regarding the 1.1-maintenance
branch,
I'll go ahead and mark this as Fixed even though it's only fixed in the
default
branch (1.2dev). But I think it would be a good idea to fix it in the
1.1-maintenance
branch as well, in case a new release 1.1.5 is made from that branch and/or
for the
sake of anyone running from the current code in that branch.
Reply all
Reply to author
Forward
0 new messages