Merge pull request #1990 from Airblader/bug-1989

Flush cairo surface after drawing text.
This commit is contained in:
Michael Stapelberg 2015-10-14 13:32:31 -07:00
commit d622df70ad
5 changed files with 182 additions and 114 deletions

View File

@ -80,4 +80,4 @@ TAILQ_HEAD(statusline_head, status_block) statusline_head;
#include "config.h"
#include "libi3.h"
#include "parse_json_header.h"
#include "cairo_util.h"
#include "draw_util.h"

View File

@ -3,12 +3,24 @@
*
* © 2015 Ingo Bürk and contributors (see also: LICENSE)
*
* cairo_util.h: Utility for operations using cairo.
* draw.h: Utility for drawing.
*
*/
#pragma once
#ifdef I3BAR_CAIRO
#include <cairo/cairo-xcb.h>
#endif
#ifdef I3BAR_CAIRO
/* We need to flush cairo surfaces twice to avoid an assertion bug. See #1989
* and https://bugs.freedesktop.org/show_bug.cgi?id=92455. */
#define CAIRO_SURFACE_FLUSH(surface) \
do { \
cairo_surface_flush(surface); \
cairo_surface_flush(surface); \
} while (0)
#endif
/* Represents a color split by color channel. */
typedef struct color_t {
@ -26,43 +38,40 @@ typedef struct surface_t {
/* The drawable which is being represented. */
xcb_drawable_t id;
// TODO remove this once i3 uses solely cairo for drawing operations
/* A classic XCB graphics context. This should not be used for
* drawing operations. */
/* A classic XCB graphics context. */
xcb_gcontext_t gc;
int width;
int height;
#ifdef I3BAR_CAIRO
/* A cairo surface representing the drawable. */
cairo_surface_t *surface;
/* The cairo object representing the drawale. In general,
* this is what one should use for any drawing operation. */
cairo_t *cr;
#endif
} surface_t;
/**
* Initialize the cairo surface to represent the given drawable.
* Initialize the surface to represent the given drawable.
*
*/
void cairo_surface_init(surface_t *surface, xcb_drawable_t drawable, int width, int height);
void draw_util_surface_init(surface_t *surface, xcb_drawable_t drawable, int width, int height);
/**
* Destroys the surface.
*
*/
void cairo_surface_free(surface_t *surface);
void draw_util_surface_free(surface_t *surface);
/**
* Parses the given color in hex format to an internal color representation.
* Note that the input must begin with a hash sign, e.g., "#3fbc59".
*
*/
color_t cairo_hex_to_color(const char *color);
/**
* Set the given color as the source color on the surface.
*
*/
void cairo_set_source_color(surface_t *surface, color_t color);
color_t draw_util_hex_to_color(const char *color);
/**
* Draw the given text using libi3.
@ -70,21 +79,25 @@ void cairo_set_source_color(surface_t *surface, color_t color);
* drawing are used. This will be the case when using XCB to draw text.
*
*/
void cairo_draw_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width);
void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width);
/**
* Draws a filled rectangle.
* This function is a convenience wrapper and takes care of flushing the
* surface as well as restoring the cairo state.
* Note that the drawing is done using CAIRO_OPERATOR_SOURCE.
*
*/
void cairo_draw_rectangle(surface_t *surface, color_t color, double x, double y, double w, double h);
void draw_util_rectangle(surface_t *surface, color_t color, double x, double y, double w, double h);
/**
* Clears a surface with the given color.
*
*/
void draw_util_clear_surface(surface_t *surface, color_t color);
/**
* Copies a surface onto another surface.
* Note that the drawing is done using CAIRO_OPERATOR_SOURCE.
*
*/
void cairo_copy_surface(surface_t *src, surface_t *dest, double src_x, double src_y,
double dest_x, double dest_y, double dest_w, double dest_h);
void draw_util_copy_surface(surface_t *src, surface_t *dest, double src_x, double src_y,
double dest_x, double dest_y, double width, double height);

View File

@ -13,7 +13,7 @@
#include <cairo/cairo-xcb.h>
#include "common.h"
#include "cairo_util.h"
#include "draw_util.h"
typedef struct i3_output i3_output;

View File

@ -3,7 +3,7 @@
*
* © 2015 Ingo Bürk and contributors (see also: LICENSE)
*
* cairo_util.c: Utility for operations using cairo.
* draw.c: Utility for drawing.
*
*/
#include <stdlib.h>
@ -11,7 +11,9 @@
#include <string.h>
#include <xcb/xcb.h>
#include <xcb/xcb_aux.h>
#ifdef I3BAR_CAIRO
#include <cairo/cairo-xcb.h>
#endif
#include "common.h"
#include "libi3.h"
@ -19,30 +21,39 @@
xcb_connection_t *xcb_connection;
xcb_visualtype_t *visual_type;
/* Forward declarations */
static void draw_util_set_source_color(surface_t *surface, color_t color);
/*
* Initialize the cairo surface to represent the given drawable.
* Initialize the surface to represent the given drawable.
*
*/
void cairo_surface_init(surface_t *surface, xcb_drawable_t drawable, int width, int height) {
void draw_util_surface_init(surface_t *surface, xcb_drawable_t drawable, int width, int height) {
surface->id = drawable;
surface->width = width;
surface->height = height;
surface->gc = xcb_generate_id(xcb_connection);
xcb_void_cookie_t gc_cookie = xcb_create_gc_checked(xcb_connection, surface->gc, surface->id, 0, NULL);
if (xcb_request_failed(gc_cookie, "Could not create graphical context"))
exit(EXIT_FAILURE);
#ifdef I3BAR_CAIRO
surface->surface = cairo_xcb_surface_create(xcb_connection, surface->id, visual_type, width, height);
surface->cr = cairo_create(surface->surface);
#endif
}
/*
* Destroys the surface.
*
*/
void cairo_surface_free(surface_t *surface) {
void draw_util_surface_free(surface_t *surface) {
xcb_free_gc(xcb_connection, surface->gc);
#ifdef I3BAR_CAIRO
cairo_surface_destroy(surface->surface);
cairo_destroy(surface->cr);
#endif
}
/*
@ -50,7 +61,7 @@ void cairo_surface_free(surface_t *surface) {
* Note that the input must begin with a hash sign, e.g., "#3fbc59".
*
*/
color_t cairo_hex_to_color(const char *color) {
color_t draw_util_hex_to_color(const char *color) {
char groups[3][3] = {
{color[1], color[2], '\0'},
{color[3], color[4], '\0'},
@ -67,8 +78,14 @@ color_t cairo_hex_to_color(const char *color) {
* Set the given color as the source color on the surface.
*
*/
void cairo_set_source_color(surface_t *surface, color_t color) {
static void draw_util_set_source_color(surface_t *surface, color_t color) {
#ifdef I3BAR_CAIRO
cairo_set_source_rgb(surface->cr, color.red, color.green, color.blue);
#else
uint32_t colorpixel = color.colorpixel;
xcb_change_gc(xcb_connection, surface->gc, XCB_GC_FOREGROUND | XCB_GC_BACKGROUND,
(uint32_t[]){colorpixel, colorpixel});
#endif
}
/**
@ -77,59 +94,108 @@ void cairo_set_source_color(surface_t *surface, color_t color) {
* drawing are used. This will be the case when using XCB to draw text.
*
*/
void cairo_draw_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width) {
void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width) {
#ifdef I3BAR_CAIRO
/* Flush any changes before we draw the text as this might use XCB directly. */
CAIRO_SURFACE_FLUSH(surface->surface);
#endif
set_font_colors(surface->gc, fg_color.colorpixel, bg_color.colorpixel);
draw_text(text, surface->id, surface->gc, visual_type, x, y, max_width);
#ifdef I3BAR_CAIRO
/* Notify cairo that we (possibly) used another way to draw on the surface. */
cairo_surface_mark_dirty(surface->surface);
#endif
}
/**
* Draws a filled rectangle.
* This function is a convenience wrapper and takes care of flushing the
* surface as well as restoring the cairo state.
* Note that the drawing is done using CAIRO_OPERATOR_SOURCE.
*
*/
void cairo_draw_rectangle(surface_t *surface, color_t color, double x, double y, double w, double h) {
void draw_util_rectangle(surface_t *surface, color_t color, double x, double y, double w, double h) {
#ifdef I3BAR_CAIRO
cairo_save(surface->cr);
/* Using the SOURCE operator will copy both color and alpha information directly
* onto the surface rather than blending it. This is a bit more efficient and
* allows better color control for the user when using opacity. */
cairo_set_operator(surface->cr, CAIRO_OPERATOR_SOURCE);
cairo_set_source_color(surface, color);
draw_util_set_source_color(surface, color);
cairo_rectangle(surface->cr, x, y, w, h);
cairo_fill(surface->cr);
/* Make sure we flush the surface for any text drawing operations that could follow.
* Since we support drawing text via XCB, we need this. */
cairo_surface_flush(surface->surface);
CAIRO_SURFACE_FLUSH(surface->surface);
cairo_restore(surface->cr);
#else
draw_util_set_source_color(surface, color);
xcb_rectangle_t rect = {x, y, w, h};
xcb_poly_fill_rectangle(xcb_connection, surface->id, surface->gc, 1, &rect);
#endif
}
/**
* Clears a surface with the given color.
*
*/
void draw_util_clear_surface(surface_t *surface, color_t color) {
#ifdef I3BAR_CAIRO
cairo_save(surface->cr);
/* Using the SOURCE operator will copy both color and alpha information directly
* onto the surface rather than blending it. This is a bit more efficient and
* allows better color control for the user when using opacity. */
cairo_set_operator(surface->cr, CAIRO_OPERATOR_SOURCE);
draw_util_set_source_color(surface, color);
cairo_paint(surface->cr);
/* Make sure we flush the surface for any text drawing operations that could follow.
* Since we support drawing text via XCB, we need this. */
CAIRO_SURFACE_FLUSH(surface->surface);
cairo_restore(surface->cr);
#else
draw_util_set_source_color(surface, color);
xcb_rectangle_t rect = {0, 0, surface->width, surface->height};
xcb_poly_fill_rectangle(xcb_connection, surface->id, surface->gc, 1, &rect);
#endif
}
/**
* Copies a surface onto another surface.
* Note that the drawing is done using CAIRO_OPERATOR_SOURCE.
*
*/
void cairo_copy_surface(surface_t *src, surface_t *dest, double src_x, double src_y,
double dest_x, double dest_y, double dest_w, double dest_h) {
void draw_util_copy_surface(surface_t *src, surface_t *dest, double src_x, double src_y,
double dest_x, double dest_y, double width, double height) {
#ifdef I3BAR_CAIRO
cairo_save(dest->cr);
/* Using the SOURCE operator will copy both color and alpha information directly
* onto the surface rather than blending it. This is a bit more efficient and
* allows better color control for the user when using opacity. */
cairo_set_operator(dest->cr, CAIRO_OPERATOR_SOURCE);
cairo_set_source_surface(dest->cr, src->surface, src_x, src_y);
cairo_set_source_surface(dest->cr, src->surface, dest_x - src_x, src_y);
cairo_rectangle(dest->cr, dest_x, dest_y, dest_w, dest_h);
cairo_rectangle(dest->cr, dest_x, dest_y, width, height);
cairo_fill(dest->cr);
/* Make sure we flush the surface for any text drawing operations that could follow.
* Since we support drawing text via XCB, we need this. */
cairo_surface_flush(dest->surface);
CAIRO_SURFACE_FLUSH(src->surface);
CAIRO_SURFACE_FLUSH(dest->surface);
cairo_restore(dest->cr);
#else
xcb_copy_area(xcb_connection, src->id, dest->id, dest->gc, (int16_t)src_x, (int16_t)src_y,
(int16_t)dest_x, (int16_t)dest_y, (uint16_t)width, (uint16_t)height);
#endif
}

View File

@ -30,7 +30,6 @@
#include <X11/Xlib.h>
#include <X11/XKBlib.h>
#include <X11/extensions/XKB.h>
#include <cairo/cairo-xcb.h>
#include "common.h"
#include "libi3.h"
@ -174,7 +173,7 @@ static void draw_separator(uint32_t x, struct status_block *block) {
uint32_t center_x = x - sep_offset;
if (config.separator_symbol == NULL) {
/* Draw a classic one pixel, vertical separator. */
cairo_draw_rectangle(&statusline_surface, colors.sep_fg,
draw_util_rectangle(&statusline_surface, colors.sep_fg,
center_x,
logical_px(sep_voff_px),
logical_px(1),
@ -182,7 +181,7 @@ static void draw_separator(uint32_t x, struct status_block *block) {
} else {
/* Draw a custom separator. */
uint32_t separator_x = MAX(x - block->sep_block_width, center_x - separator_symbol_width / 2);
cairo_draw_text(config.separator_symbol, &statusline_surface, colors.sep_fg, colors.bar_bg,
draw_util_text(config.separator_symbol, &statusline_surface, colors.sep_fg, colors.bar_bg,
separator_x, logical_px(ws_voff_px), x - separator_x);
}
}
@ -244,12 +243,7 @@ void refresh_statusline(bool use_short_text) {
realloc_sl_buffer();
/* Clear the statusline pixmap. */
cairo_save(statusline_surface.cr);
cairo_set_source_color(&statusline_surface, colors.bar_bg);
cairo_set_operator(statusline_surface.cr, CAIRO_OPERATOR_SOURCE);
cairo_paint(statusline_surface.cr);
cairo_surface_flush(statusline_surface.surface);
cairo_restore(statusline_surface.cr);
draw_util_clear_surface(&statusline_surface, colors.bar_bg);
/* Draw the text of each block. */
uint32_t x = 0;
@ -263,16 +257,16 @@ void refresh_statusline(bool use_short_text) {
fg_color = colors.urgent_ws_fg;
/* Draw the background */
cairo_draw_rectangle(&statusline_surface, colors.urgent_ws_bg,
draw_util_rectangle(&statusline_surface, colors.urgent_ws_bg,
x - logical_px(2),
logical_px(1),
block->width + logical_px(4),
bar_height - logical_px(2));
} else {
fg_color = (block->color ? cairo_hex_to_color(block->color) : colors.bar_fg);
fg_color = (block->color ? draw_util_hex_to_color(block->color) : colors.bar_fg);
}
cairo_draw_text(block->full_text, &statusline_surface, fg_color, colors.bar_bg,
draw_util_text(block->full_text, &statusline_surface, fg_color, colors.bar_bg,
x + block->x_offset, logical_px(ws_voff_px), block->width);
x += block->width + block->sep_block_width + block->x_offset + block->x_append;
@ -353,7 +347,7 @@ void unhide_bars(void) {
void init_colors(const struct xcb_color_strings_t *new_colors) {
#define PARSE_COLOR(name, def) \
do { \
colors.name = cairo_hex_to_color(new_colors->name ? new_colors->name : def); \
colors.name = draw_util_hex_to_color(new_colors->name ? new_colors->name : def); \
} while (0)
PARSE_COLOR(bar_fg, "#FFFFFF");
PARSE_COLOR(bar_bg, "#000000");
@ -374,7 +368,7 @@ void init_colors(const struct xcb_color_strings_t *new_colors) {
#define PARSE_COLOR_FALLBACK(name, fallback) \
do { \
colors.name = new_colors->name ? cairo_hex_to_color(new_colors->name) : colors.fallback; \
colors.name = new_colors->name ? draw_util_hex_to_color(new_colors->name) : colors.fallback; \
} while (0)
/* For the binding mode indicator colors, we don't hardcode a default.
@ -1133,7 +1127,7 @@ char *init_xcb_early() {
xcb_root,
root_screen->width_in_pixels,
root_screen->height_in_pixels);
cairo_surface_init(&statusline_surface, statusline_id, root_screen->width_in_pixels, root_screen->height_in_pixels);
draw_util_surface_init(&statusline_surface, statusline_id, root_screen->width_in_pixels, root_screen->height_in_pixels);
/* The various watchers to communicate with xcb */
xcb_io = smalloc(sizeof(ev_io));
@ -1495,7 +1489,7 @@ void realloc_sl_buffer(void) {
DLOG("Re-allocating statusline buffer, statusline_width = %d, root_screen->width_in_pixels = %d\n",
statusline_width, root_screen->width_in_pixels);
xcb_free_pixmap(xcb_connection, statusline_surface.id);
cairo_surface_free(&statusline_surface);
draw_util_surface_free(&statusline_surface);
xcb_pixmap_t statusline_id = xcb_generate_id(xcb_connection);
xcb_void_cookie_t sl_pm_cookie = xcb_create_pixmap_checked(xcb_connection,
@ -1504,7 +1498,7 @@ void realloc_sl_buffer(void) {
xcb_root,
MAX(root_screen->width_in_pixels, statusline_width),
bar_height);
cairo_surface_init(&statusline_surface, statusline_id, root_screen->width_in_pixels, root_screen->height_in_pixels);
draw_util_surface_init(&statusline_surface, statusline_id, root_screen->width_in_pixels, root_screen->height_in_pixels);
if (xcb_request_failed(sl_pm_cookie, "Could not allocate statusline buffer"))
exit(EXIT_FAILURE);
@ -1655,8 +1649,8 @@ void reconfig_windows(bool redraw_bars) {
1,
(unsigned char *)&atoms[_NET_WM_WINDOW_TYPE_DOCK]);
cairo_surface_init(&walk->bar, bar_id, walk->rect.w, bar_height);
cairo_surface_init(&walk->buffer, buffer_id, walk->rect.w, bar_height);
draw_util_surface_init(&walk->bar, bar_id, walk->rect.w, bar_height);
draw_util_surface_init(&walk->buffer, buffer_id, walk->rect.w, bar_height);
xcb_void_cookie_t strut_cookie = config_strut_partial(walk);
@ -1736,10 +1730,10 @@ void reconfig_windows(bool redraw_bars) {
walk->rect.w,
bar_height);
cairo_surface_free(&(walk->bar));
cairo_surface_free(&(walk->buffer));
cairo_surface_init(&(walk->bar), walk->bar.id, walk->rect.w, bar_height);
cairo_surface_init(&(walk->buffer), walk->buffer.id, walk->rect.w, bar_height);
draw_util_surface_free(&(walk->bar));
draw_util_surface_free(&(walk->buffer));
draw_util_surface_init(&(walk->bar), walk->bar.id, walk->rect.w, bar_height);
draw_util_surface_init(&(walk->buffer), walk->buffer.id, walk->rect.w, bar_height);
xcb_void_cookie_t map_cookie, umap_cookie;
if (redraw_bars) {
@ -1797,12 +1791,7 @@ void draw_bars(bool unhide) {
}
/* First things first: clear the backbuffer */
cairo_save(outputs_walk->buffer.cr);
cairo_set_source_color(&(outputs_walk->buffer), colors.bar_bg);
cairo_set_operator(outputs_walk->buffer.cr, CAIRO_OPERATOR_SOURCE);
cairo_paint(outputs_walk->buffer.cr);
cairo_surface_flush(outputs_walk->buffer.surface);
cairo_restore(outputs_walk->buffer.cr);
draw_util_clear_surface(&(outputs_walk->buffer), colors.bar_bg);
if (!config.disable_ws) {
i3_ws *ws_walk;
@ -1832,20 +1821,20 @@ void draw_bars(bool unhide) {
}
/* Draw the border of the button. */
cairo_draw_rectangle(&(outputs_walk->buffer), border_color,
draw_util_rectangle(&(outputs_walk->buffer), border_color,
workspace_width,
logical_px(1),
ws_walk->name_width + 2 * logical_px(ws_hoff_px) + 2 * logical_px(1),
font.height + 2 * logical_px(ws_voff_px) - 2 * logical_px(1));
/* Draw the inside of the button. */
cairo_draw_rectangle(&(outputs_walk->buffer), bg_color,
draw_util_rectangle(&(outputs_walk->buffer), bg_color,
workspace_width + logical_px(1),
2 * logical_px(1),
ws_walk->name_width + 2 * logical_px(ws_hoff_px),
font.height + 2 * logical_px(ws_voff_px) - 4 * logical_px(1));
cairo_draw_text(ws_walk->name, &(outputs_walk->buffer), fg_color, bg_color,
draw_util_text(ws_walk->name, &(outputs_walk->buffer), fg_color, bg_color,
workspace_width + logical_px(ws_hoff_px) + logical_px(1),
logical_px(ws_voff_px),
ws_walk->name_width);
@ -1862,19 +1851,19 @@ void draw_bars(bool unhide) {
color_t fg_color = colors.binding_mode_fg;
color_t bg_color = colors.binding_mode_bg;
cairo_draw_rectangle(&(outputs_walk->buffer), colors.binding_mode_border,
draw_util_rectangle(&(outputs_walk->buffer), colors.binding_mode_border,
workspace_width,
logical_px(1),
binding.width + 2 * logical_px(ws_hoff_px) + 2 * logical_px(1),
font.height + 2 * logical_px(ws_voff_px) - 2 * logical_px(1));
cairo_draw_rectangle(&(outputs_walk->buffer), bg_color,
draw_util_rectangle(&(outputs_walk->buffer), bg_color,
workspace_width + logical_px(1),
2 * logical_px(1),
binding.width + 2 * logical_px(ws_hoff_px),
font.height + 2 * logical_px(ws_voff_px) - 4 * logical_px(1));
cairo_draw_text(binding.name, &(outputs_walk->buffer), fg_color, bg_color,
draw_util_text(binding.name, &(outputs_walk->buffer), fg_color, bg_color,
workspace_width + logical_px(ws_hoff_px) + logical_px(1),
logical_px(ws_voff_px),
binding.width);
@ -1907,7 +1896,7 @@ void draw_bars(bool unhide) {
int x_src = (int16_t)(statusline_width - visible_statusline_width);
int x_dest = (int16_t)(outputs_walk->rect.w - tray_width - logical_px(sb_hoff_px) - visible_statusline_width);
cairo_copy_surface(&statusline_surface, &(outputs_walk->buffer), x_dest - x_src, 0,
draw_util_copy_surface(&statusline_surface, &(outputs_walk->buffer), x_src, 0,
x_dest, 0, (int16_t)visible_statusline_width, (int16_t)bar_height);
}
@ -1937,7 +1926,7 @@ void redraw_bars(void) {
continue;
}
cairo_copy_surface(&(outputs_walk->buffer), &(outputs_walk->bar), 0, 0,
draw_util_copy_surface(&(outputs_walk->buffer), &(outputs_walk->bar), 0, 0,
0, 0, outputs_walk->rect.w, outputs_walk->rect.h);
xcb_flush(xcb_connection);
}