patch 8.0.1450: GUI: endless loop when stopping cursor blinking

brammool · brammool · commit 1dd45fb4f337 · 2018-01-31T21:10:01.000+01:00
Problem:    Endless loop when gui_mch_stop_blink() is called while blink_state
            is BLINK_OFF. (zdohnal)
Solution:   Avoid calling gui_update_cursor() recursively.
diff --git a/src/gui.c b/src/gui.c
@@ -1124,7 +1124,7 @@ gui_update_cursor(
 			     shape->blinkoff);
 	if (shape->blinkwait == 0 || shape->blinkon == 0
 						       || shape->blinkoff == 0)
-	    gui_mch_stop_blink();
+	    gui_mch_stop_blink(FALSE);
 #ifdef FEAT_TERMINAL
 	if (shape_bg != INVALCOLOR)
 	{
@@ -2982,7 +2982,7 @@ gui_wait_for_chars(long wtime, int tb_change_cnt)
 	 * for showmatch() */
 	gui_mch_start_blink();
 	retval = gui_wait_for_chars_or_timer(wtime);
-	gui_mch_stop_blink();
+	gui_mch_stop_blink(TRUE);
 	return retval;
     }
 
@@ -3029,7 +3029,7 @@ gui_wait_for_chars(long wtime, int tb_change_cnt)
 	retval = gui_wait_for_chars_or_timer(-1L);
     }
 
-    gui_mch_stop_blink();
+    gui_mch_stop_blink(TRUE);
     return retval;
 }
 
diff --git a/src/gui_gtk_x11.c b/src/gui_gtk_x11.c
@@ -893,14 +893,14 @@ gui_mch_set_blinking(long waittime, long on, long off)
  * Stop the cursor blinking.  Show the cursor if it wasn't shown.
  */
     void
-gui_mch_stop_blink(void)
+gui_mch_stop_blink(int may_call_gui_update_cursor)
 {
     if (blink_timer)
     {
 	timeout_remove(blink_timer);
 	blink_timer = 0;
     }
-    if (blink_state == BLINK_OFF)
+    if (blink_state == BLINK_OFF && may_call_gui_update_cursor)
     {
 	gui_update_cursor(TRUE, FALSE);
 	gui_mch_flush();
@@ -975,7 +975,7 @@ leave_notify_event(GtkWidget *widget UNUSED,
 		   gpointer data UNUSED)
 {
     if (blink_state != BLINK_NONE)
-	gui_mch_stop_blink();
+	gui_mch_stop_blink(TRUE);
 
     return FALSE;
 }
@@ -1006,7 +1006,7 @@ focus_out_event(GtkWidget *widget UNUSED,
     gui_focus_change(FALSE);
 
     if (blink_state != BLINK_NONE)
-	gui_mch_stop_blink();
+	gui_mch_stop_blink(TRUE);
 
     return TRUE;
 }
@@ -1145,7 +1145,7 @@ key_press_event(GtkWidget *widget UNUSED,
 
 #if GTK_CHECK_VERSION(3,0,0)
     is_key_pressed = TRUE;
-    gui_mch_stop_blink();
+    gui_mch_stop_blink(TRUE);
 #endif
 
     gui.event_time = event->time;
@@ -6677,7 +6677,7 @@ gui_mch_wait_for_chars(long wtime)
 	    if (gui.in_focus)
 		gui_mch_start_blink();
 	    else
-		gui_mch_stop_blink();
+		gui_mch_stop_blink(TRUE);
 	    focus = gui.in_focus;
 	}
 
diff --git a/src/gui_mac.c b/src/gui_mac.c
@@ -5156,9 +5156,10 @@ gui_mch_set_blinking(long wait, long on, long off)
  * Stop the cursor blinking.  Show the cursor if it wasn't shown.
  */
     void
-gui_mch_stop_blink(void)
+gui_mch_stop_blink(int may_call_gui_update_cursor)
 {
-    gui_update_cursor(TRUE, FALSE);
+    if (may_call_gui_update_cursor)
+	gui_update_cursor(TRUE, FALSE);
     /* TODO: TODO: TODO: TODO: */
 /*    gui_w32_rm_blink_timer();
     if (blink_state == BLINK_OFF)
diff --git a/src/gui_photon.c b/src/gui_photon.c
@@ -383,7 +383,7 @@ gui_ph_handle_window_cb(PtWidget_t *widget, void *data, PtCallbackInfo_t *info)
 	    else
 	    {
 		gui_focus_change(FALSE);
-		gui_mch_stop_blink();
+		gui_mch_stop_blink(TRUE);
 	    }
 	    break;
 
@@ -2273,11 +2273,11 @@ gui_mch_start_blink(void)
 }
 
     void
-gui_mch_stop_blink(void)
+gui_mch_stop_blink(int may_call_gui_update_cursor)
 {
     PtSetResource(gui_ph_timer_cursor, Pt_ARG_TIMER_INITIAL, 0, 0);
 
-    if (blink_state == BLINK_OFF)
+    if (blink_state == BLINK_OFF && may_call_gui_update_cursor)
 	gui_update_cursor(TRUE, FALSE);
 
     blink_state = BLINK_NONE;
diff --git a/src/gui_w32.c b/src/gui_w32.c
@@ -638,10 +638,10 @@ gui_mswin_rm_blink_timer(void)
  * Stop the cursor blinking.  Show the cursor if it wasn't shown.
  */
     void
-gui_mch_stop_blink(void)
+gui_mch_stop_blink(int may_call_gui_update_cursor)
 {
     gui_mswin_rm_blink_timer();
-    if (blink_state == BLINK_OFF)
+    if (blink_state == BLINK_OFF && may_call_gui_update_cursor)
     {
 	gui_update_cursor(TRUE, FALSE);
 	gui_mch_flush();
@@ -2111,7 +2111,7 @@ gui_mch_wait_for_chars(int wtime)
 	    if (gui.in_focus)
 		gui_mch_start_blink();
 	    else
-		gui_mch_stop_blink();
+		gui_mch_stop_blink(TRUE);
 	    focus = gui.in_focus;
 	}
 
diff --git a/src/gui_x11.c b/src/gui_x11.c
@@ -2746,7 +2746,7 @@ gui_mch_wait_for_chars(long wtime)
 	    if (gui.in_focus)
 		gui_mch_start_blink();
 	    else
-		gui_mch_stop_blink();
+		gui_mch_stop_blink(TRUE);
 	    focus = gui.in_focus;
 	}
 
@@ -3105,14 +3105,14 @@ gui_mch_set_blinking(long waittime, long on, long off)
  * Stop the cursor blinking.  Show the cursor if it wasn't shown.
  */
     void
-gui_mch_stop_blink(void)
+gui_mch_stop_blink(int may_call_gui_update_cursor)
 {
     if (blink_timer != (XtIntervalId)0)
     {
 	XtRemoveTimeOut(blink_timer);
 	blink_timer = (XtIntervalId)0;
     }
-    if (blink_state == BLINK_OFF)
+    if (blink_state == BLINK_OFF && may_call_gui_update_cursor)
 	gui_update_cursor(TRUE, FALSE);
     blink_state = BLINK_NONE;
 }
diff --git a/src/proto/gui_gtk_x11.pro b/src/proto/gui_gtk_x11.pro
@@ -4,7 +4,7 @@ void gui_mch_free_all(void);
 int gui_mch_is_blinking(void);
 int gui_mch_is_blink_off(void);
 void gui_mch_set_blinking(long waittime, long on, long off);
-void gui_mch_stop_blink(void);
+void gui_mch_stop_blink(int may_call_gui_update_cursor);
 void gui_mch_start_blink(void);
 int gui_mch_early_init_check(int give_message);
 int gui_mch_init_check(void);
@@ -25,7 +25,7 @@ int gui_mch_maximized(void);
 void gui_mch_unmaximize(void);
 void gui_mch_newfont(void);
 void gui_mch_set_shellsize(int width, int height, int min_width, int min_height, int base_width, int base_height, int direction);
-void gui_gtk_get_screen_size_of_win(GtkWidget *win, int *width, int *height);
+void gui_gtk_get_screen_size_of_win(GtkWidget *wid, int *width, int *height);
 void gui_mch_get_screen_dimensions(int *screen_w, int *screen_h);
 void gui_mch_settitle(char_u *title, char_u *icon);
 void gui_mch_enable_menu(int showit);
diff --git a/src/proto/gui_mac.pro b/src/proto/gui_mac.pro
@@ -17,7 +17,7 @@ short gui_mch_get_mac_menu_item_index(vimmenu_T *menu, vimmenu_T *parent);
 int gui_mch_is_blinking(void);
 int gui_mch_is_blink_off(void);
 void gui_mch_set_blinking(long wait, long on, long off);
-void gui_mch_stop_blink(void);
+void gui_mch_stop_blink(int may_call_gui_update_cursor);
 void gui_mch_start_blink(void);
 void gui_mch_getmouse(int *x, int *y);
 void gui_mch_setmouse(int x, int y);
diff --git a/src/proto/gui_photon.pro b/src/proto/gui_photon.pro
@@ -44,7 +44,7 @@ int gui_mch_is_blinking(void);
 int gui_mch_is_blink_off(void);
 void gui_mch_set_blinking(long wait, long on, long off);
 void gui_mch_start_blink(void);
-void gui_mch_stop_blink(void);
+void gui_mch_stop_blink(int may_call_gui_update_cursor);
 void gui_mch_beep(void);
 void gui_mch_flash(int msec);
 void gui_mch_flush(void);
diff --git a/src/proto/gui_w32.pro b/src/proto/gui_w32.pro
@@ -3,7 +3,7 @@ int gui_mch_set_rendering_options(char_u *s);
 int gui_mch_is_blinking(void);
 int gui_mch_is_blink_off(void);
 void gui_mch_set_blinking(long wait, long on, long off);
-void gui_mch_stop_blink(void);
+void gui_mch_stop_blink(int may_call_gui_update_cursor);
 void gui_mch_start_blink(void);
 LRESULT WINAPI vim_WindowProc(HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam);
 void gui_mch_new_colors(void);
diff --git a/src/proto/gui_x11.pro b/src/proto/gui_x11.pro
@@ -57,7 +57,7 @@ void gui_x11_menu_cb(Widget w, XtPointer client_data, XtPointer call_data);
 int gui_mch_is_blinking(void);
 int gui_mch_is_blink_off(void);
 void gui_mch_set_blinking(long waittime, long on, long off);
-void gui_mch_stop_blink(void);
+void gui_mch_stop_blink(int may_call_gui_update_cursor);
 void gui_mch_start_blink(void);
 guicolor_T gui_mch_get_rgb(guicolor_T pixel);
 void gui_x11_callbacks(Widget textArea, Widget vimForm);
diff --git a/src/version.c b/src/version.c
@@ -771,6 +771,8 @@ static char *(features[]) =
 
 static int included_patches[] =
 {   /* Add new patch number below this line */
+/**/
+    1450,
 /**/
     1449,
 /**/

Original file line number	Diff line number	Diff line change
`@@ -1124,7 +1124,7 @@ gui_update_cursor(`
`1124`	`1124`	`shape->blinkoff);`
`1125`	`1125`	`if (shape->blinkwait == 0 \|\| shape->blinkon == 0`
`1126`	`1126`	`\|\| shape->blinkoff == 0)`
`1127`		`- gui_mch_stop_blink();`
	`1127`	`+ gui_mch_stop_blink(FALSE);`
`1128`	`1128`	`#ifdef FEAT_TERMINAL`
`1129`	`1129`	`if (shape_bg != INVALCOLOR)`
`1130`	`1130`	`{`
`@@ -2982,7 +2982,7 @@ gui_wait_for_chars(long wtime, int tb_change_cnt)`
`2982`	`2982`	`* for showmatch() */`
`2983`	`2983`	`gui_mch_start_blink();`
`2984`	`2984`	`retval = gui_wait_for_chars_or_timer(wtime);`
`2985`		`- gui_mch_stop_blink();`
	`2985`	`+ gui_mch_stop_blink(TRUE);`
`2986`	`2986`	`return retval;`
`2987`	`2987`	`}`
`2988`	`2988`
`@@ -3029,7 +3029,7 @@ gui_wait_for_chars(long wtime, int tb_change_cnt)`
`3029`	`3029`	`retval = gui_wait_for_chars_or_timer(-1L);`
`3030`	`3030`	`}`
`3031`	`3031`
`3032`		`- gui_mch_stop_blink();`
	`3032`	`+ gui_mch_stop_blink(TRUE);`
`3033`	`3033`	`return retval;`
`3034`	`3034`	`}`
`3035`	`3035`
Original file line number	Diff line number	Diff line change
`@@ -893,14 +893,14 @@ gui_mch_set_blinking(long waittime, long on, long off)`
`893`	`893`	`* Stop the cursor blinking. Show the cursor if it wasn't shown.`
`894`	`894`	`*/`
`895`	`895`	`void`
`896`		`-gui_mch_stop_blink(void)`
	`896`	`+gui_mch_stop_blink(int may_call_gui_update_cursor)`
`897`	`897`	`{`
`898`	`898`	`if (blink_timer)`
`899`	`899`	`{`
`900`	`900`	`timeout_remove(blink_timer);`
`901`	`901`	`blink_timer = 0;`
`902`	`902`	`}`
`903`		`- if (blink_state == BLINK_OFF)`
	`903`	`+ if (blink_state == BLINK_OFF && may_call_gui_update_cursor)`
`904`	`904`	`{`
`905`	`905`	`gui_update_cursor(TRUE, FALSE);`
`906`	`906`	`gui_mch_flush();`
`@@ -975,7 +975,7 @@ leave_notify_event(GtkWidget *widget UNUSED,`
`975`	`975`	`gpointer data UNUSED)`
`976`	`976`	`{`
`977`	`977`	`if (blink_state != BLINK_NONE)`
`978`		`- gui_mch_stop_blink();`
	`978`	`+ gui_mch_stop_blink(TRUE);`
`979`	`979`
`980`	`980`	`return FALSE;`
`981`	`981`	`}`
`@@ -1006,7 +1006,7 @@ focus_out_event(GtkWidget *widget UNUSED,`
`1006`	`1006`	`gui_focus_change(FALSE);`
`1007`	`1007`
`1008`	`1008`	`if (blink_state != BLINK_NONE)`
`1009`		`- gui_mch_stop_blink();`
	`1009`	`+ gui_mch_stop_blink(TRUE);`
`1010`	`1010`
`1011`	`1011`	`return TRUE;`
`1012`	`1012`	`}`
`@@ -1145,7 +1145,7 @@ key_press_event(GtkWidget *widget UNUSED,`
`1145`	`1145`
`1146`	`1146`	`#if GTK_CHECK_VERSION(3,0,0)`
`1147`	`1147`	`is_key_pressed = TRUE;`
`1148`		`- gui_mch_stop_blink();`
	`1148`	`+ gui_mch_stop_blink(TRUE);`
`1149`	`1149`	`#endif`
`1150`	`1150`
`1151`	`1151`	`gui.event_time = event->time;`
`@@ -6677,7 +6677,7 @@ gui_mch_wait_for_chars(long wtime)`
`6677`	`6677`	`if (gui.in_focus)`
`6678`	`6678`	`gui_mch_start_blink();`
`6679`	`6679`	`else`
`6680`		`- gui_mch_stop_blink();`
	`6680`	`+ gui_mch_stop_blink(TRUE);`
`6681`	`6681`	`focus = gui.in_focus;`
`6682`	`6682`	`}`
`6683`	`6683`
Original file line number	Diff line number	Diff line change
`@@ -383,7 +383,7 @@ gui_ph_handle_window_cb(PtWidget_t widget, void data, PtCallbackInfo_t *info)`
`383`	`383`	`else`
`384`	`384`	`{`
`385`	`385`	`gui_focus_change(FALSE);`
`386`		`- gui_mch_stop_blink();`
	`386`	`+ gui_mch_stop_blink(TRUE);`
`387`	`387`	`}`
`388`	`388`	`break;`
`389`	`389`
`@@ -2273,11 +2273,11 @@ gui_mch_start_blink(void)`
`2273`	`2273`	`}`
`2274`	`2274`
`2275`	`2275`	`void`
`2276`		`-gui_mch_stop_blink(void)`
	`2276`	`+gui_mch_stop_blink(int may_call_gui_update_cursor)`
`2277`	`2277`	`{`
`2278`	`2278`	`PtSetResource(gui_ph_timer_cursor, Pt_ARG_TIMER_INITIAL, 0, 0);`
`2279`	`2279`
`2280`		`- if (blink_state == BLINK_OFF)`
	`2280`	`+ if (blink_state == BLINK_OFF && may_call_gui_update_cursor)`
`2281`	`2281`	`gui_update_cursor(TRUE, FALSE);`
`2282`	`2282`
`2283`	`2283`	`blink_state = BLINK_NONE;`
Original file line number	Diff line number	Diff line change
`@@ -2746,7 +2746,7 @@ gui_mch_wait_for_chars(long wtime)`
`2746`	`2746`	`if (gui.in_focus)`
`2747`	`2747`	`gui_mch_start_blink();`
`2748`	`2748`	`else`
`2749`		`- gui_mch_stop_blink();`
	`2749`	`+ gui_mch_stop_blink(TRUE);`
`2750`	`2750`	`focus = gui.in_focus;`
`2751`	`2751`	`}`
`2752`	`2752`
`@@ -3105,14 +3105,14 @@ gui_mch_set_blinking(long waittime, long on, long off)`
`3105`	`3105`	`* Stop the cursor blinking. Show the cursor if it wasn't shown.`
`3106`	`3106`	`*/`
`3107`	`3107`	`void`
`3108`		`-gui_mch_stop_blink(void)`
	`3108`	`+gui_mch_stop_blink(int may_call_gui_update_cursor)`
`3109`	`3109`	`{`
`3110`	`3110`	`if (blink_timer != (XtIntervalId)0)`
`3111`	`3111`	`{`
`3112`	`3112`	`XtRemoveTimeOut(blink_timer);`
`3113`	`3113`	`blink_timer = (XtIntervalId)0;`
`3114`	`3114`	`}`
`3115`		`- if (blink_state == BLINK_OFF)`
	`3115`	`+ if (blink_state == BLINK_OFF && may_call_gui_update_cursor)`
`3116`	`3116`	`gui_update_cursor(TRUE, FALSE);`
`3117`	`3117`	`blink_state = BLINK_NONE;`
`3118`	`3118`	`}`