mutter/cogl/cogl-display.c
Robert Bragg cc4c578887 fix cogl_context_new crash if fail to connect renderer
If a NULL display is passed to cogl_context_new() then it has to
implicitly create a CoglRenderer and CoglDisplay and propagate any
resulting errors back to the user. Previously the implementation relied
on passing a NULL renderer to cogl_display_new() as the means for
implicitly connecting to a renderer. The problem with this though is
that cogl_display_new() isn't designed to ever return NULL but if it
failed to connect to a renderer automatically it would do and then
cogl_context_new would pass NULL to cogl_display_setup() leading to a
crash.

This patch changes the implementation of cogl_context_new() to now
explicitly create a CoglRenderer and connect to it if a NULL display is
given. This way we can easily propagate any errors. In addition
cogl_display_new has been changed to abort if it fails to implicitly
connect to a renderer due to a NULL renderer argument.

An application needing to gracefully handle problems connecting to a
renderer at runtime should manually instantiate and connect a renderer
passing a GError argument to cogl_renderer_connect.

Reviewed-by: Neil Roberts <neil@linux.intel.com>
2012-04-11 12:26:52 +01:00

156 lines
3.7 KiB
C

/*
* Cogl
*
* An object oriented GL/GLES Abstraction/Utility Layer
*
* Copyright (C) 2011 Intel Corporation.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
* Authors:
* Robert Bragg <robert@linux.intel.com>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <string.h>
#include "cogl-private.h"
#include "cogl-object.h"
#include "cogl-internal.h"
#include "cogl-display-private.h"
#include "cogl-renderer-private.h"
#include "cogl-winsys-private.h"
static void _cogl_display_free (CoglDisplay *display);
COGL_OBJECT_DEFINE (Display, display);
static const CoglWinsysVtable *
_cogl_display_get_winsys (CoglDisplay *display)
{
return display->renderer->winsys_vtable;
}
static void
_cogl_display_free (CoglDisplay *display)
{
const CoglWinsysVtable *winsys;
if (display->setup)
{
winsys = _cogl_display_get_winsys (display);
winsys->display_destroy (display);
display->setup = FALSE;
}
if (display->renderer)
{
cogl_object_unref (display->renderer);
display->renderer = NULL;
}
if (display->onscreen_template)
{
cogl_object_unref (display->onscreen_template);
display->onscreen_template = NULL;
}
g_slice_free (CoglDisplay, display);
}
CoglDisplay *
cogl_display_new (CoglRenderer *renderer,
CoglOnscreenTemplate *onscreen_template)
{
CoglDisplay *display = g_slice_new0 (CoglDisplay);
GError *error = NULL;
_cogl_init ();
display->renderer = renderer;
if (renderer)
cogl_object_ref (renderer);
else
display->renderer = cogl_renderer_new ();
if (!cogl_renderer_connect (display->renderer, &error))
g_error ("Failed to connect to renderer: %s\n", error->message);
display->onscreen_template = onscreen_template;
if (onscreen_template)
cogl_object_ref (onscreen_template);
else
display->onscreen_template = cogl_onscreen_template_new (NULL);
display->setup = FALSE;
#ifdef COGL_HAS_EGL_PLATFORM_GDL_SUPPORT
display->gdl_plane = GDL_PLANE_ID_UPP_C;
#endif
return _cogl_display_object_new (display);
}
CoglRenderer *
cogl_display_get_renderer (CoglDisplay *display)
{
return display->renderer;
}
gboolean
cogl_display_setup (CoglDisplay *display,
GError **error)
{
const CoglWinsysVtable *winsys;
if (display->setup)
return TRUE;
winsys = _cogl_display_get_winsys (display);
if (!winsys->display_setup (display, error))
return FALSE;
display->setup = TRUE;
return TRUE;
}
#ifdef COGL_HAS_EGL_PLATFORM_GDL_SUPPORT
void
cogl_gdl_display_set_plane (CoglDisplay *display,
gdl_plane_id_t plane)
{
_COGL_RETURN_IF_FAIL (display->setup == FALSE);
display->gdl_plane = plane;
}
#endif
#ifdef COGL_HAS_WAYLAND_EGL_SERVER_SUPPORT
void
cogl_wayland_display_set_compositor_display (CoglDisplay *display,
struct wl_display *wayland_display)
{
_COGL_RETURN_IF_FAIL (display->setup == FALSE);
display->wayland_compositor_display = wayland_display;
}
#endif