Ryujinx-GtkSharp/cairo/Surface.cs
Andrés G. Aragoneses 70d1827058 cairo: Throw ObjectDisposedException after an object has been disposed
Potentially all these IDisposable classes could be used after being
disposed, which would result in native crashes. We now do an explicit
check and throw an exception in managed land when the object has been
disposed.

This is particularly useful because:
 a/ the native crashes are quite obscure, there no indication that
you're using a disposed object
 b/ Gtk# is passing Context instances to user methods, and disposes them
when the method returns. So if the user code keeps a reference to the
Context, there a good chance it will try to use it after it's disposed.

Other changes in this patch include:
 * Renaming a parameter to be more consistent with the other subsequent
ctor called.
 * Replacing implementation of some [Obsolete()] methods with the call
to the methods they were replaced with, to avoid redundancy and the
need for more CheckDisposed() calls than necessary.
 * Throw ArgumentException when receiving an IntPtr.Zero as a handle,
as a way to protect ourselves from wrapping invalid native pointers,
and throwing ObjectDisposedExceptions because the object was invalid in
the first place.

Signed-off-by: Bertrand Lorentz <bertrand.lorentz@gmail.com>
2013-11-24 15:56:26 +01:00

260 lines
6.3 KiB
C#

//
// Mono.Cairo.Surface.cs
//
// Authors:
// Duncan Mak
// Miguel de Icaza.
// Alp Toker
//
// (C) Ximian Inc, 2003.
// (C) Novell, Inc. 2003.
//
// This is an OO wrapper API for the Cairo API
//
// Copyright (C) 2004 Novell, Inc (http://www.novell.com)
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Collections;
namespace Cairo {
public class Surface : IDisposable
{
[Obsolete]
protected static Hashtable surfaces = new Hashtable ();
IntPtr handle = IntPtr.Zero;
[Obsolete]
protected Surface()
{
}
[Obsolete]
protected Surface (IntPtr handle) : this (handle, true)
{
}
protected Surface (IntPtr handle, bool owner)
{
if (handle == IntPtr.Zero)
throw new ArgumentException ("handle should not be NULL", "handle");
this.handle = handle;
if (!owner)
NativeMethods.cairo_surface_reference (handle);
if (CairoDebug.Enabled)
CairoDebug.OnAllocated (handle);
}
public static Surface Lookup (IntPtr surface, bool owned)
{
SurfaceType st = NativeMethods.cairo_surface_get_type (surface);
switch (st) {
case SurfaceType.Image:
return new ImageSurface (surface, owned);
case SurfaceType.Xlib:
return new XlibSurface (surface, owned);
case SurfaceType.Xcb:
return new XcbSurface (surface, owned);
case SurfaceType.Glitz:
return new GlitzSurface (surface, owned);
case SurfaceType.Win32:
return new Win32Surface (surface, owned);
case SurfaceType.Pdf:
return new PdfSurface (surface, owned);
case SurfaceType.PS:
return new PSSurface (surface, owned);
case SurfaceType.DirectFB:
return new DirectFBSurface (surface, owned);
case SurfaceType.Svg:
return new SvgSurface (surface, owned);
default:
return new Surface (surface, owned);
}
}
[Obsolete ("Use an ImageSurface constructor instead.")]
public static Cairo.Surface CreateForImage (
ref byte[] data, Cairo.Format format, int width, int height, int stride)
{
IntPtr p = NativeMethods.cairo_image_surface_create_for_data (
data, format, width, height, stride);
return new Cairo.Surface (p, true);
}
[Obsolete ("Use an ImageSurface constructor instead.")]
public static Cairo.Surface CreateForImage (
Cairo.Format format, int width, int height)
{
IntPtr p = NativeMethods.cairo_image_surface_create (
format, width, height);
return new Cairo.Surface (p, true);
}
public Cairo.Surface CreateSimilar (
Cairo.Content content, int width, int height)
{
IntPtr p = NativeMethods.cairo_surface_create_similar (
this.Handle, content, width, height);
return new Cairo.Surface (p, true);
}
~Surface ()
{
Dispose (false);
}
//[Obsolete ("Use Context.SetSource() followed by Context.Paint()")]
public void Show (Context gr, double x, double y)
{
NativeMethods.cairo_set_source_surface (gr.Handle, handle, x, y);
NativeMethods.cairo_paint (gr.Handle);
}
public void Dispose ()
{
Dispose (true);
GC.SuppressFinalize (this);
}
protected virtual void Dispose (bool disposing)
{
if (!disposing || CairoDebug.Enabled)
CairoDebug.OnDisposed<Surface> (handle, disposing);
if (!disposing || handle == IntPtr.Zero)
return;
NativeMethods.cairo_surface_destroy (handle);
handle = IntPtr.Zero;
}
protected void CheckDisposed ()
{
if (handle == IntPtr.Zero)
throw new ObjectDisposedException ("Object has already been disposed");
}
public Status Finish ()
{
CheckDisposed ();
NativeMethods.cairo_surface_finish (handle);
return Status;
}
public void Flush ()
{
CheckDisposed ();
NativeMethods.cairo_surface_flush (handle);
}
public void MarkDirty ()
{
CheckDisposed ();
NativeMethods.cairo_surface_mark_dirty (Handle);
}
public void MarkDirty (Rectangle rectangle)
{
CheckDisposed ();
NativeMethods.cairo_surface_mark_dirty_rectangle (Handle, (int)rectangle.X, (int)rectangle.Y, (int)rectangle.Width, (int)rectangle.Height);
}
public IntPtr Handle {
get {
return handle;
}
}
public PointD DeviceOffset {
get {
CheckDisposed ();
double x, y;
NativeMethods.cairo_surface_get_device_offset (handle, out x, out y);
return new PointD (x, y);
}
set {
CheckDisposed ();
NativeMethods.cairo_surface_set_device_offset (handle, value.X, value.Y);
}
}
[Obsolete ("Use Dispose()")]
public void Destroy()
{
Dispose ();
}
public void SetFallbackResolution (double x, double y)
{
CheckDisposed ();
NativeMethods.cairo_surface_set_fallback_resolution (handle, x, y);
}
public void WriteToPng (string filename)
{
CheckDisposed ();
NativeMethods.cairo_surface_write_to_png (handle, filename);
}
[Obsolete ("Use Handle instead.")]
public IntPtr Pointer {
get {
return handle;
}
}
public Status Status {
get {
CheckDisposed ();
return NativeMethods.cairo_surface_status (handle);
}
}
public Content Content {
get {
CheckDisposed ();
return NativeMethods.cairo_surface_get_content (handle);
}
}
public SurfaceType SurfaceType {
get {
CheckDisposed ();
return NativeMethods.cairo_surface_get_type (handle);
}
}
public uint ReferenceCount {
get {
return NativeMethods.cairo_surface_get_reference_count (handle); }
}
}
}