ComputeResource.cs

#region License

/*

Copyright (c) 2009 - 2013 Fatjon Sakiqi

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.

*/

#endregion

namespace Cloo
{
    using System;
    using System.Diagnostics;

    ////////////////////////////////////////////////////////////////////////////////////////////////////
    /// <summary>   Represents an OpenCL resource. </summary>
    ///
    /// <remarks>
    /// An OpenCL resource is an OpenCL object that can be created and deleted by the application.
    /// </remarks>
    ///
    /// <seealso cref="T:Cloo.ComputeObject"/>
    /// <seealso cref="T:System.IDisposable"/>
    /// <seealso cref="ComputeObject"/>
    ////////////////////////////////////////////////////////////////////////////////////////////////////

    public abstract class ComputeResource : ComputeObject, IDisposable
    {
        #region Public methods

        ////////////////////////////////////////////////////////////////////////////////////////////////////
        /// <summary>
        /// Deletes the <see cref="ComputeResource"/> and frees its accompanying OpenCL resources.
        /// </summary>
        ///
        /// <seealso cref="M:System.IDisposable.Dispose()"/>
        ////////////////////////////////////////////////////////////////////////////////////////////////////

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
            GC.KeepAlive(this);
        }

        #endregion

        #region Protected methods

        ////////////////////////////////////////////////////////////////////////////////////////////////////
        /// <summary>   Releases the associated OpenCL object. </summary>
        ///
        /// <remarks>
        /// <paramref name="manual"/> must be <c>true</c> if this method is invoked directly by the
        /// application.
        /// </remarks>
        ///
        /// <param name="manual">   Specifies the operation mode of this method. </param>
        ////////////////////////////////////////////////////////////////////////////////////////////////////

        protected abstract void Dispose(bool manual);

        #endregion

        #region Private methods

        /// <summary>   Releases the associated OpenCL object. </summary>
        ~ComputeResource()
        {
            Trace.WriteLine(ToString() + " leaked!", "Warning");
            Dispose(false);
        }

        #endregion
    }
}