git.sesse.net Git - vlc/blob - bindings/cil/src/marshal.cs

   1 /**
   2  * @file marshal.cs
   3  * @brief Common LibVLC objects marshalling utilities
   4  * @ingroup Internals
   5  */
   6
   7 /**********************************************************************
   8  *  Copyright (C) 2007-2009 Rémi Denis-Courmont.                      *
   9  *  This program is free software; you can redistribute and/or modify *
  10  *  it under the terms of the GNU General Public License as published *
  11  *  by the Free Software Foundation; version 2 of the license, or (at *
  12  *  your option) any later version.                                   *
  13  *                                                                    *
  14  *  This program is distributed in the hope that it will be useful,   *
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of    *
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.              *
  17  *  See the GNU General Public License for more details.              *
  18  *                                                                    *
  19  *  You should have received a copy of the GNU General Public License *
  20  *  along with this program; if not, you can get it from:             *
  21  *  http://www.gnu.org/copyleft/gpl.html                              *
  22  **********************************************************************/
  23
  24 using System;
  25 using System.Runtime.InteropServices;
  26
  27 namespace VideoLAN.LibVLC
  28 {
  29     /**
  30      * @brief NonNullHandle: abstract safe handle class for non-NULL pointers
  31      * @ingroup Internals
  32      * Microsoft.* namespace has a similar class. However we want to use the
  33      * System.* namespace only.
  34      */
  35     internal abstract class NonNullHandle : SafeHandle
  36     {
  37         protected NonNullHandle ()
  38             : base (IntPtr.Zero, true)
  39         {
  40         }
  41
  42         /**
  43          * System.Runtime.InteropServices.SafeHandle::IsInvalid.
  44          */
  45         public override bool IsInvalid
  46         {
  47             get
  48             {
  49                 return handle == IntPtr.Zero;
  50             }
  51         }
  52
  53         /**
  54          * Destroys an handle. Cannot fail.
  55          */
  56         protected abstract void Destroy ();
  57
  58         /**
  59          * System.Runtime.InteropServices.SafeHandle::ReleaseHandle.
  60          */
  61         protected override bool ReleaseHandle ()
  62         {
  63             Destroy ();
  64             return true;
  65         }
  66
  67     };
  68
  69     /**
  70      * @brief BaseObject: generic wrapper around a safe handle.
  71      * @ingroup Internals
  72      * This is the baseline for all managed LibVLC objects which wrap
  73      * an unmanaged LibVLC pointer.
  74      */
  75     public class BaseObject : IDisposable
  76     {
  77         protected NativeException ex; /**< buffer for LibVLC exceptions */
  78         protected SafeHandle handle; /**< wrapped safe handle */
  79
  80         internal BaseObject ()
  81         {
  82             ex = new NativeException ();
  83             this.handle = null;
  84         }
  85
  86         /**
  87          * Checks if the LibVLC run-time raised an exception
  88          * If so, raises a CIL exception.
  89          */
  90         protected void Raise ()
  91         {
  92             ex.Raise ();
  93         }
  94
  95         /**
  96          * IDisposable::Dispose.
  97          */
  98         public void Dispose ()
  99         {
 100             Dispose (true);
 101             GC.SuppressFinalize (this);
 102         }
 103
 104         protected virtual void Dispose (bool disposing)
 105         {
 106             if (disposing)
 107             {
 108                 ex.Dispose ();
 109                 if (handle != null)
 110                     handle.Close ();
 111             }
 112             ex = null;
 113             handle = null;
 114         }
 115     };
 116 };