Introduce a new compositor architecture

Having spent the last dev cycle looking at how we could specialize the
compositors for various backends, we once again look for the
commonalities in order to reduce the duplication. In part this is
motivated by the idea that spans is a good interface for both the
existent GL backend and pixman, and so they deserve a dedicated
compositor. xcb/xlib target an identical rendering system and so they
should be using the same compositor, and it should be possible to run
that same compositor locally against pixman to generate reference tests.

Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>

P.S. This brings massive upheaval (read breakage) I've tried delaying in
order to fix as many things as possible but now this one patch does far,
far, far too much. Apologies in advance for breaking your favourite
backend, but trust me in that the end result will be much better. :)

1 files changed, 211 insertions, 43 deletions

diff --git a/src/cairo-xlib-private.h b/src/cairo-xlib-private.h
index 3a32eff26..452283233 100644
--- a/src/cairo-xlib-private.h
+++ b/src/cairo-xlib-private.h
@@ -46,21 +46,15 @@
 #include "cairo-list-private.h"
 #include "cairo-reference-count-private.h"
 #include "cairo-types-private.h"
+#include "cairo-scaled-font-private.h"
+#include "cairo-surface-private.h"
 
 #include <pixman.h>
 
 typedef struct _cairo_xlib_display cairo_xlib_display_t;
 typedef struct _cairo_xlib_screen cairo_xlib_screen_t;
-
-typedef struct _cairo_xlib_hook cairo_xlib_hook_t;
-typedef struct _cairo_xlib_job cairo_xlib_job_t;
-typedef void (*cairo_xlib_notify_func) (Display *, void *);
-typedef void (*cairo_xlib_notify_resource_func) (Display *, XID);
-
-struct _cairo_xlib_hook {
-    cairo_xlib_hook_t *prev, *next; /* private */
-    void (*func) (cairo_xlib_display_t *display, void *data);
-};
+typedef struct _cairo_xlib_source cairo_xlib_source_t;
+typedef struct _cairo_xlib_surface cairo_xlib_surface_t;
 
 /* size of color cube */
 #define CUBE_SIZE 6
@@ -76,20 +70,43 @@ struct _cairo_xlib_display {
 
     Display *display;
     cairo_list_t screens;
+    cairo_list_t fonts;
+
+    const cairo_compositor_t *compositor;
 
     int render_major;
     int render_minor;
     XRenderPictFormat *cached_xrender_formats[CAIRO_FORMAT_RGB16_565 + 1];
 
-    cairo_xlib_job_t *workqueue;
-    cairo_freelist_t wq_freelist;
-
     int force_precision;
 
-    cairo_xlib_hook_t *close_display_hooks;
-    unsigned int buggy_gradients :1;
-    unsigned int buggy_pad_reflect :1;
-    unsigned int buggy_repeat :1;
+    cairo_surface_t *white;
+    cairo_surface_t *alpha[256];
+    cairo_surface_t *solid[32];
+    uint32_t solid_cache[32]; /* low 16 are opaque, high 16 transparent */
+    struct {
+	uint32_t color;
+	int index;
+    } last_solid_cache[2];
+
+    /* TRUE if the server has a bug with repeating pictures
+     *
+     *  https://bugs.freedesktop.org/show_bug.cgi?id=3566
+     *
+     * We can't test for this because it depends on whether the
+     * picture is in video memory or not.
+     *
+     * We also use this variable as a guard against a second
+     * independent bug with transformed repeating pictures:
+     *
+     * http://lists.freedesktop.org/archives/cairo/2004-September/001839.html
+     *
+     * Both are fixed in xorg >= 6.9 and hopefully in > 6.8.2, so
+     * we can reuse the test for now.
+     */
+    unsigned int buggy_gradients : 1;
+    unsigned int buggy_pad_reflect : 1;
+    unsigned int buggy_repeat : 1;
     unsigned int closed :1;
 };
 
@@ -120,6 +137,79 @@ struct _cairo_xlib_screen {
     cairo_list_t visuals;
 };
 
+enum {
+    GLYPHSET_INDEX_ARGB32,
+    GLYPHSET_INDEX_A8,
+    GLYPHSET_INDEX_A1,
+    NUM_GLYPHSETS
+};
+
+typedef struct _cairo_xlib_font_glyphset {
+    GlyphSet		glyphset;
+    cairo_format_t	format;
+    XRenderPictFormat	*xrender_format;
+    struct _cairo_xlib_font_glyphset_free_glyphs {
+	int		count;
+	unsigned long	indices[128];
+    } to_free;
+} cairo_xlib_font_glyphset_t;
+
+typedef struct _cairo_xlib_font {
+    cairo_scaled_font_private_t		base;
+    cairo_scaled_font_t			*font;
+    cairo_device_t			*device;
+    cairo_list_t			link;
+    cairo_xlib_font_glyphset_t		glyphset[NUM_GLYPHSETS];
+} cairo_xlib_font_t;
+
+struct _cairo_xlib_surface {
+    cairo_surface_t base;
+
+    Picture picture;
+
+    const cairo_compositor_t *compositor;
+
+    cairo_xlib_display_t *display;
+    cairo_xlib_screen_t *screen;
+    cairo_list_t link;
+
+    Display *dpy; /* only valid between acquire/release */
+    Drawable drawable;
+    cairo_bool_t owns_pixmap;
+    Visual *visual;
+
+    int use_pixmap;
+
+    int width;
+    int height;
+    int depth;
+
+    int precision;
+    XRenderPictFormat *xrender_format;
+    /* XXX pixman_format instead of masks? */
+    uint32_t a_mask;
+    uint32_t r_mask;
+    uint32_t g_mask;
+    uint32_t b_mask;
+
+    struct _cairo_xlib_source {
+	cairo_surface_t base;
+
+	Picture picture;
+	Display *dpy;
+
+	unsigned int filter:3;
+	unsigned int extend:3;
+	unsigned int has_matrix:1;
+	unsigned int has_component_alpha:1;
+    } embedded_source;
+};
+
+cairo_private cairo_status_t
+_cairo_xlib_surface_get_gc (cairo_xlib_display_t *display,
+                            cairo_xlib_surface_t *surface,
+                            GC                   *gc);
+
 cairo_private cairo_device_t *
 _cairo_xlib_device_create (Display *display);
 
@@ -127,29 +217,10 @@ cairo_private cairo_xlib_screen_t *
 _cairo_xlib_display_get_screen (cairo_xlib_display_t *display,
 				Screen *screen);
 
-cairo_private void
-_cairo_xlib_add_close_display_hook (cairo_xlib_display_t *display, cairo_xlib_hook_t *hook);
-
-cairo_private void
-_cairo_xlib_remove_close_display_hook (cairo_xlib_display_t *display, cairo_xlib_hook_t *hook);
-
-cairo_private cairo_status_t
-_cairo_xlib_display_queue_work (cairo_xlib_display_t *display,
-	                        cairo_xlib_notify_func notify,
-				void *data,
-				void (*destroy)(void *));
-cairo_private cairo_status_t
-_cairo_xlib_display_queue_resource (cairo_xlib_display_t *display,
-	                           cairo_xlib_notify_resource_func notify,
-				   XID resource);
 cairo_private cairo_status_t
 _cairo_xlib_display_acquire (cairo_device_t *device,
                              cairo_xlib_display_t **display);
 
-cairo_private void
-_cairo_xlib_display_get_xrender_version (cairo_xlib_display_t *display,
-					 int *major, int *minor);
-
 cairo_private cairo_bool_t
 _cairo_xlib_display_has_repeat (cairo_device_t *device);
 
@@ -177,21 +248,17 @@ _cairo_xlib_screen_get (Display *dpy,
 			cairo_xlib_screen_t **out);
 
 cairo_private void
-_cairo_xlib_screen_destroy (cairo_xlib_screen_t *info);
-
-cairo_private void
-_cairo_xlib_screen_close_display (cairo_xlib_display_t *display,
-                                  cairo_xlib_screen_t *info);
+_cairo_xlib_screen_destroy (cairo_xlib_display_t *display,
+			    cairo_xlib_screen_t *info);
 
 cairo_private GC
 _cairo_xlib_screen_get_gc (cairo_xlib_display_t *display,
                            cairo_xlib_screen_t *info,
 			   int depth,
 			   Drawable drawable);
-
 cairo_private void
 _cairo_xlib_screen_put_gc (cairo_xlib_display_t *display,
-                           cairo_xlib_screen_t *info,
+			   cairo_xlib_screen_t *info,
 			   int depth,
 			   GC gc);
 
@@ -213,4 +280,105 @@ _cairo_xlib_visual_info_create (Display *dpy,
 cairo_private void
 _cairo_xlib_visual_info_destroy (cairo_xlib_visual_info_t *info);
 
+cairo_private const cairo_compositor_t *
+_cairo_xlib_core_compositor_get (void);
+
+cairo_private const cairo_compositor_t *
+_cairo_xlib_fallback_compositor_get (void);
+
+cairo_private const cairo_compositor_t *
+_cairo_xlib_mask_compositor_get (void);
+
+cairo_private const cairo_compositor_t *
+_cairo_xlib_traps_compositor_get (void);
+
+cairo_private void
+_cairo_xlib_surface_ensure_picture (cairo_xlib_surface_t    *surface);
+
+cairo_private void
+_cairo_xlib_surface_set_precision (cairo_xlib_surface_t	*surface,
+				   cairo_antialias_t	 antialias);
+
+cairo_private cairo_int_status_t
+_cairo_xlib_surface_set_attributes (cairo_xlib_display_t       *display,
+                                    cairo_xlib_surface_t       *surface,
+				    cairo_surface_attributes_t *attributes,
+				    double			xc,
+				    double			yc);
+
+cairo_private cairo_status_t
+_cairo_xlib_surface_draw_image (cairo_xlib_surface_t   *surface,
+				cairo_image_surface_t  *image,
+				int                    src_x,
+				int                    src_y,
+				int                    width,
+				int                    height,
+				int                    dst_x,
+				int                    dst_y);
+
+cairo_private cairo_surface_t *
+_cairo_xlib_source_create_for_pattern (cairo_surface_t *dst,
+				       const cairo_pattern_t *pattern,
+				       cairo_bool_t is_mask,
+				       const cairo_rectangle_int_t *extents,
+				       const cairo_rectangle_int_t *sample,
+				       int *src_x, int *src_y);
+
+cairo_private void
+_cairo_xlib_font_close (cairo_xlib_font_t *font);
+
+#define CAIRO_RENDER_AT_LEAST(surface, major, minor)	\
+	(((surface)->render_major > major) ||			\
+	 (((surface)->render_major == major) && ((surface)->render_minor >= minor)))
+
+#define CAIRO_RENDER_HAS_CREATE_PICTURE(surface)		CAIRO_RENDER_AT_LEAST((surface), 0, 0)
+#define CAIRO_RENDER_HAS_COMPOSITE(surface)		CAIRO_RENDER_AT_LEAST((surface), 0, 0)
+#define CAIRO_RENDER_HAS_COMPOSITE_TEXT(surface)	CAIRO_RENDER_AT_LEAST((surface), 0, 0)
+
+#define CAIRO_RENDER_HAS_FILL_RECTANGLES(surface)		CAIRO_RENDER_AT_LEAST((surface), 0, 1)
+
+#define CAIRO_RENDER_HAS_DISJOINT(surface)			CAIRO_RENDER_AT_LEAST((surface), 0, 2)
+#define CAIRO_RENDER_HAS_CONJOINT(surface)			CAIRO_RENDER_AT_LEAST((surface), 0, 2)
+
+#define CAIRO_RENDER_HAS_TRAPEZOIDS(surface)		CAIRO_RENDER_AT_LEAST((surface), 0, 4)
+#define CAIRO_RENDER_HAS_TRIANGLES(surface)		CAIRO_RENDER_AT_LEAST((surface), 0, 4)
+#define CAIRO_RENDER_HAS_TRISTRIP(surface)			CAIRO_RENDER_AT_LEAST((surface), 0, 4)
+#define CAIRO_RENDER_HAS_TRIFAN(surface)			CAIRO_RENDER_AT_LEAST((surface), 0, 4)
+
+#define CAIRO_RENDER_HAS_PICTURE_TRANSFORM(surface)	CAIRO_RENDER_AT_LEAST((surface), 0, 6)
+#define CAIRO_RENDER_HAS_FILTERS(surface)	CAIRO_RENDER_AT_LEAST((surface), 0, 6)
+
+#define CAIRO_RENDER_HAS_EXTENDED_REPEAT(surface)	CAIRO_RENDER_AT_LEAST((surface), 0, 10)
+#define CAIRO_RENDER_HAS_GRADIENTS(surface)	CAIRO_RENDER_AT_LEAST((surface), 0, 10)
+
+#define CAIRO_RENDER_HAS_PDF_OPERATORS(surface)	CAIRO_RENDER_AT_LEAST((surface), 0, 11)
+
+#define CAIRO_RENDER_SUPPORTS_OPERATOR(surface, op)	\
+     ((op) <= CAIRO_OPERATOR_SATURATE ||			\
+      (CAIRO_RENDER_HAS_PDF_OPERATORS(surface) &&	\
+       (op) <= CAIRO_OPERATOR_HSL_LUMINOSITY))
+
+/*
+ * Return whether two xlib surfaces share the same
+ * screen.  Both core and Render drawing require this
+ * when using multiple drawables in an operation.
+ */
+static inline cairo_bool_t
+_cairo_xlib_surface_same_screen (cairo_xlib_surface_t *dst,
+				 cairo_xlib_surface_t *src)
+{
+    return dst->screen == src->screen;
+}
+
+static inline void
+_cairo_xlib_surface_put_gc (cairo_xlib_display_t *display,
+                            cairo_xlib_surface_t *surface,
+                            GC                    gc)
+{
+    _cairo_xlib_screen_put_gc (display,
+                               surface->screen,
+			       surface->depth,
+			       gc);
+}
+
 #endif /* CAIRO_XLIB_PRIVATE_H */