src/Tizen.NUI/src/internal/Disposable.cs

   1 /*
   2  * Copyright(c) 2019 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17 using System.ComponentModel;
  18
  19 namespace Tizen.NUI
  20 {
  21     /// <summary>
  22     /// Disposable class.
  23     /// </summary>
  24     /// <since_tizen> 6 </since_tizen>
  25     public class Disposable : global::System.IDisposable
  26     {
  27         /// <summary>
  28         /// A Flag to check if it is already disposed.
  29         /// </summary>
  30         /// <since_tizen> 6 </since_tizen>
  31         protected bool disposed = false;
  32
  33         /// This will not be public.
  34         [EditorBrowsable(EditorBrowsableState.Never)]
  35         protected bool swigCMemOwn;
  36
  37         /// This will not be public.
  38         [EditorBrowsable(EditorBrowsableState.Never)]
  39         protected global::System.Runtime.InteropServices.HandleRef swigCPtr;
  40
  41         private bool isDisposeQueued = false;
  42
  43         /// <summary>
  44         /// Create an instance of Disposable.
  45         /// </summary>
  46         /// <since_tizen> 6 </since_tizen>
  47         public Disposable()
  48         {
  49             swigCMemOwn = false;
  50             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
  51         }
  52
  53         /// This will not be public.
  54         [EditorBrowsable(EditorBrowsableState.Never)]
  55         public Disposable(global::System.IntPtr cPtr, bool cMemoryOwn)
  56         {
  57             swigCMemOwn = cMemoryOwn;
  58             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  59         }
  60
  61         /// <summary>
  62         /// Dispose.
  63         /// </summary>
  64         /// <since_tizen> 6 </since_tizen>
  65         ~Disposable()
  66         {
  67             if (!isDisposeQueued)
  68             {
  69                 isDisposeQueued = true;
  70                 DisposeQueue.Instance.Add(this);
  71             }
  72         }
  73
  74         /// <summary>
  75         /// Dispose.
  76         /// </summary>
  77         /// <since_tizen> 6 </since_tizen>
  78         public void Dispose()
  79         {
  80             //Throw excpetion if Dispose() is called in separate thread.
  81             if (!Window.IsInstalled())
  82             {
  83                 throw new System.InvalidOperationException("This API called from separate thread. This API must be called from MainThread.");
  84             }
  85
  86             if (isDisposeQueued)
  87             {
  88                 Dispose(DisposeTypes.Implicit);
  89             }
  90             else
  91             {
  92                 Dispose(DisposeTypes.Explicit);
  93                 System.GC.SuppressFinalize(this);
  94             }
  95         }
  96
  97         /// <summary>
  98         /// Dispose.
  99         /// </summary>
 100         /// <since_tizen> 6 </since_tizen>
 101         protected virtual void Dispose(DisposeTypes type)
 102         {
 103             if (disposed)
 104             {
 105                 return;
 106             }
 107
 108             if (type == DisposeTypes.Explicit)
 109             {
 110                 //Called by User
 111                 //Release your own managed resources here.
 112                 //You should release all of your own disposable objects here.
 113             }
 114
 115             //Release your own unmanaged resources here.
 116             //You should not access any managed member here except static instance.
 117             //because the execution order of Finalizes is non-deterministic.
 118             if (swigCPtr.Handle != global::System.IntPtr.Zero)
 119             {
 120                 if (swigCMemOwn)
 121                 {
 122                     swigCMemOwn = false;
 123                     ReleaseSwigCPtr(swigCPtr);
 124                 }
 125                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
 126             }
 127
 128             disposed = true;
 129         }
 130
 131         /// <summary>
 132         /// Release swigCPtr.
 133         /// </summary>
 134         /// <since_tizen> 6 </since_tizen>
 135         /// This will not be public opened.
 136         [EditorBrowsable(EditorBrowsableState.Never)]
 137         protected virtual void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
 138         {
 139         }
 140     }
 141 }