src/Tizen.NUI/src/public/Common/BaseHandle.cs

   1 /*
   2  * Copyright(c) 2021 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;
  18 using System.ComponentModel;
  19 using System.Runtime.CompilerServices;
  20 using Tizen.NUI.Binding;
  21
  22 namespace Tizen.NUI
  23 {
  24     /// <summary>
  25     /// BaseHandle is a handle to an internal Dali resource.
  26     /// </summary>
  27     /// <since_tizen> 3 </since_tizen>
  28     public class BaseHandle : Element, global::System.IDisposable
  29     {
  30         /// <summary>
  31         /// swigCMemOwn
  32         /// </summary>
  33         /// <since_tizen> 3 </since_tizen>
  34         [Obsolete("Deprecated in API9, Will be removed in API11, Please use SwigCMemOwn")]
  35         [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "<Pending>")]
  36         protected bool swigCMemOwn;
  37
  38         /// <summary>
  39         /// A flag to check if it is already disposed.
  40         /// </summary>
  41         /// <since_tizen> 3 </since_tizen>
  42         [Obsolete("Deprecated in API9, Will be removed in API11, Please use Disposed")]
  43         [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "<Pending>")]
  44         protected bool disposed = false;
  45
  46         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
  47         private global::System.Runtime.InteropServices.HandleRef swigCPtrCopy;
  48         private bool registerMe;
  49
  50         //A Flag to check who called Dispose(). (By User or DisposeQueue)
  51         private bool isDisposeQueued = false;
  52
  53         /// <summary>
  54         /// Create an instance of BaseHandle.
  55         /// </summary>
  56         /// <since_tizen> 3 </since_tizen>
  57         public BaseHandle() : this(Interop.BaseHandle.NewBaseHandle())
  58         {
  59             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  60         }
  61
  62         /// <summary>
  63         /// Create an instance of BaseHandle.
  64         /// </summary>
  65         /// <param name="handle">The BaseHandle instance.</param>
  66         /// <since_tizen> 3 </since_tizen>
  67         public BaseHandle(BaseHandle handle) : this(Interop.BaseHandle.NewBaseHandle(BaseHandle.getCPtr(handle)))
  68         {
  69             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  70         }
  71
  72         internal BaseHandle(global::System.IntPtr cPtr, bool cMemoryOwn)
  73         {
  74             //to catch derived classes dali native exceptions
  75             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  76
  77             registerMe = swigCMemOwn = cMemoryOwn;
  78             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  79             // using copy constructor to create another native handle so Registry.Unregister works fine.
  80             swigCPtrCopy = new global::System.Runtime.InteropServices.HandleRef(this, Interop.BaseHandle.NewBaseHandle(swigCPtr));
  81             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  82
  83             if (registerMe)
  84             {
  85
  86                 // Register this instance of BaseHandle in the registry.
  87                 Registry.Register(this);
  88             }
  89         }
  90
  91         internal BaseHandle(global::System.IntPtr cPtr)
  92         {
  93             registerMe = swigCMemOwn = true;
  94
  95             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  96
  97             // using copy constructor to create another native handle so Registry.Unregister works fine.
  98             swigCPtrCopy = new global::System.Runtime.InteropServices.HandleRef(this, Interop.BaseHandle.NewBaseHandle(SwigCPtr));
  99             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 100
 101             if (registerMe)
 102             {
 103                 // Register this instance of BaseHandle in the registry.
 104                 Registry.Register(this);
 105             }
 106         }
 107
 108         /// <summary>
 109         /// Dispose.
 110         /// </summary>
 111         /// <since_tizen> 3 </since_tizen>
 112         ~BaseHandle() => Dispose(false);
 113
 114         /// <summary>
 115         /// Event when a property is set.
 116         /// </summary>
 117         /// <since_tizen> 5 </since_tizen>
 118         /// <seealso cref="BindableObject.PropertyChanged"/>
 119         [Obsolete("Deprecated in API9, Will be removed in API11, Please use BindableObject.PropertyChanged instead!")]
 120         public event PropertyChangedEventHandler PropertySet;
 121
 122         internal global::System.Runtime.InteropServices.HandleRef GetBaseHandleCPtrHandleRef
 123         {
 124             get
 125             {
 126                 return swigCPtrCopy;
 127             }
 128         }
 129
 130         /// <summary>
 131         /// Returns the bool value true to indicate that an operand is true and returns false otherwise.
 132         /// </summary>
 133         /// <since_tizen> 3 </since_tizen>
 134         public static bool operator true(BaseHandle handle)
 135         {
 136             // if the C# object is null, return false
 137             if (BaseHandle.ReferenceEquals(handle, null))
 138             {
 139                 return false;
 140             }
 141             // returns true if the handle has a body, false otherwise
 142             return handle.HasBody();
 143         }
 144
 145         /// <summary>
 146         /// Returns the bool false  to indicate that an operand is false and returns true otherwise.
 147         /// </summary>
 148         /// <since_tizen> 3 </since_tizen>
 149         public static bool operator false(BaseHandle handle)
 150         {
 151             // if the C# object is null, return true
 152             if (BaseHandle.ReferenceEquals(handle, null))
 153             {
 154                 return true;
 155             }
 156             return !handle.HasBody();
 157         }
 158
 159         /// <summary>
 160         /// Explicit conversion from Handle to bool.
 161         /// </summary>
 162         /// <since_tizen> 3 </since_tizen>
 163         public static explicit operator bool(BaseHandle handle)
 164         {
 165             // if the C# object is null, return false
 166             if (BaseHandle.ReferenceEquals(handle, null))
 167             {
 168                 return false;
 169             }
 170             // returns true if the handle has a body, false otherwise
 171             return handle.HasBody();
 172         }
 173
 174         /// <summary>
 175         /// Equality operator
 176         /// </summary>
 177         /// <since_tizen> 3 </since_tizen>
 178         public static bool operator ==(BaseHandle x, BaseHandle y)
 179         {
 180             // if the C# objects are the same return true
 181             if (BaseHandle.ReferenceEquals(x, y))
 182             {
 183                 return true;
 184             }
 185             if (!BaseHandle.ReferenceEquals(x, null) && !BaseHandle.ReferenceEquals(y, null))
 186             {
 187                 // drop into native code to see if both handles point to the same body
 188                 return x.IsEqual(y);
 189             }
 190
 191             if (BaseHandle.ReferenceEquals(x, null) && !BaseHandle.ReferenceEquals(y, null))
 192             {
 193                 if (y.HasBody()) return false;
 194                 else return true;
 195             }
 196             if (!BaseHandle.ReferenceEquals(x, null) && BaseHandle.ReferenceEquals(y, null))
 197             {
 198                 if (x.HasBody()) return false;
 199                 else return true;
 200             }
 201
 202             return false;
 203         }
 204
 205         /// <summary>
 206         /// Inequality operator. Returns Null if either operand is Null
 207         /// </summary>
 208         /// <since_tizen> 3 </since_tizen>
 209         public static bool operator !=(BaseHandle x, BaseHandle y)
 210         {
 211             return !(x == y);
 212         }
 213
 214         /// <summary>
 215         /// Logical AND operator.<br />
 216         /// It's possible when doing a  operator this function (opBitwiseAnd) is never called due to short circuiting.<br />
 217         /// </summary>
 218         /// <since_tizen> 3 </since_tizen>
 219         public static BaseHandle operator &(BaseHandle x, BaseHandle y)
 220         {
 221             if (x == y)
 222             {
 223                 return x;
 224             }
 225             return null;
 226         }
 227
 228         /// <summary>
 229         /// Logical OR operator for ||.<br />
 230         /// It's possible when doing a || this function (opBitwiseOr) is never called due to short circuiting.<br />
 231         /// </summary>
 232         /// <since_tizen> 3 </since_tizen>
 233         public static BaseHandle operator |(BaseHandle x, BaseHandle y)
 234         {
 235             if (!BaseHandle.ReferenceEquals(x, null) || !BaseHandle.ReferenceEquals(y, null))
 236             {
 237                 if (x != null && x.HasBody())
 238                 {
 239                     return x;
 240                 }
 241                 if (y != null && y.HasBody())
 242                 {
 243                     return y;
 244                 }
 245                 return null;
 246             }
 247             return null;
 248         }
 249
 250         /// <summary>
 251         /// Logical ! operator
 252         /// </summary>
 253         /// <since_tizen> 3 </since_tizen>
 254         public static bool operator !(BaseHandle x)
 255         {
 256             // if the C# object is null, return true
 257             if (BaseHandle.ReferenceEquals(x, null))
 258             {
 259                 return true;
 260             }
 261             if (x.HasBody())
 262             {
 263                 return false;
 264             }
 265             return true;
 266         }
 267
 268         /// <summary>
 269         /// Equals
 270         /// </summary>
 271         /// <param name="o">The object should be compared.</param>
 272         /// <returns>True if equal.</returns>
 273         /// <since_tizen> 5 </since_tizen>
 274         public override bool Equals(object o)
 275         {
 276             return base.Equals(o);
 277         }
 278
 279         /// <summary>
 280         /// Gets the hash code of this baseHandle.
 281         /// </summary>
 282         /// <returns>The hash code.</returns>
 283         /// <since_tizen> 5 </since_tizen>
 284         public override int GetHashCode()
 285         {
 286             return base.GetHashCode();
 287         }
 288
 289         /// <summary>
 290         /// Dispose.
 291         /// </summary>
 292         /// <since_tizen> 3 </since_tizen>
 293         public void Dispose()
 294         {
 295             Dispose(true);
 296             System.GC.SuppressFinalize(this);
 297         }
 298
 299         /// <summary>
 300         /// Hidden API (Inhouse API).
 301         /// Dispose.
 302         /// </summary>
 303         /// <remarks>
 304         /// Following the guide of https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/implementing-dispose.
 305         /// This will replace "protected virtual void Dispose(DisposeTypes type)" which is exactly same in functionality.
 306         /// </remarks>
 307         /// <param name="disposing">true in order to free managed objects</param>
 308         // Protected implementation of Dispose pattern.
 309         [EditorBrowsable(EditorBrowsableState.Never)]
 310         protected virtual void Dispose(bool disposing)
 311         {
 312             if (disposed)
 313             {
 314                 return;
 315             }
 316
 317             if (disposing)
 318             {
 319                 // TODO: dispose managed state (managed objects).
 320                 // Explicit call. user calls Dispose()
 321
 322                 //Throw exception if Dispose() is called in separate thread.
 323                 if (!Window.IsInstalled())
 324                 {
 325                     throw new System.InvalidOperationException("This API called from separate thread. This API must be called from MainThread.");
 326                 }
 327
 328                 if (isDisposeQueued)
 329                 {
 330                     Dispose(DisposeTypes.Implicit);
 331                 }
 332                 else
 333                 {
 334                     Dispose(DisposeTypes.Explicit);
 335                 }
 336             }
 337             else
 338             {
 339                 // Implicit call. user doesn't call Dispose(), so this object is added into DisposeQueue to be disposed automatically.
 340                 if (!isDisposeQueued)
 341                 {
 342                     isDisposeQueued = true;
 343                     DisposeQueue.Instance.Add(this);
 344                 }
 345             }
 346
 347             // TODO: free unmanaged resources (unmanaged objects) and override a finalizer below.
 348             // TODO: set large fields to null.
 349         }
 350
 351
 352         /// <summary>
 353         /// Performs an action on this object with the given action name and attributes.
 354         /// </summary>
 355         /// <param name="actionName">The command for the action.</param>
 356         /// <param name="attributes">The list of attributes for the action.</param>
 357         /// <returns>The action is performed by the object or not.</returns>
 358         /// <since_tizen> 3 </since_tizen>
 359         public bool DoAction(string actionName, PropertyMap attributes)
 360         {
 361             bool ret = Interop.BaseHandle.DoAction(swigCPtrCopy, actionName, PropertyMap.getCPtr(attributes));
 362             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 363             return ret;
 364         }
 365
 366         /// <summary>
 367         /// Returns the type name for the Handle.<br />
 368         /// Will return an empty string if the typename does not exist. This will happen for types that
 369         /// have not registered with type-registry.
 370         /// </summary>
 371         /// <returns>The type name. Empty string if the typename does not exist.</returns>
 372         /// <since_tizen> 3 </since_tizen>
 373         public string GetTypeName()
 374         {
 375             string ret = Interop.BaseHandle.GetTypeName(swigCPtrCopy);
 376             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 377             return ret;
 378         }
 379
 380         /// <summary>
 381         /// Returns the type info for the Handle.<br />
 382         /// </summary>
 383         /// <param name="info">The type information.</param>
 384         /// <returns>True If get the type info.</returns>
 385         /// <since_tizen> 3 </since_tizen>
 386         public bool GetTypeInfo(Tizen.NUI.TypeInfo info)
 387         {
 388             bool ret = Interop.BaseHandle.GetTypeInfo(swigCPtrCopy, Tizen.NUI.TypeInfo.getCPtr(info));
 389             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 390             return ret;
 391         }
 392
 393         /// <summary>
 394         /// Resets the handle.
 395         /// </summary>
 396         /// <since_tizen> 3 </since_tizen>
 397         public void Reset()
 398         {
 399             Interop.BaseHandle.Reset(swigCPtrCopy);
 400             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 401         }
 402
 403         /// <summary>
 404         /// To check the BaseHandle instance is equal or not.
 405         /// </summary>
 406         /// <param name="rhs">The baseHandle instance.</param>
 407         /// <returns>True If equal.</returns>
 408         /// <since_tizen> 3 </since_tizen>
 409         public bool EqualTo(BaseHandle rhs)
 410         {
 411             bool ret = Interop.BaseHandle.EqualTo(swigCPtrCopy, BaseHandle.getCPtr(rhs));
 412             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 413             return ret;
 414         }
 415
 416         /// <summary>
 417         /// To check the BaseHandle instance is equal or not.
 418         /// </summary>
 419         /// <param name="rhs">The baseHandle instance.</param>
 420         /// <returns>True If not equal.</returns>
 421         /// <since_tizen> 3 </since_tizen>
 422         public bool NotEqualTo(BaseHandle rhs)
 423         {
 424             bool ret = Interop.BaseHandle.NotEqualTo(swigCPtrCopy, BaseHandle.getCPtr(rhs));
 425             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 426             return ret;
 427         }
 428
 429         /// <summary>
 430         /// To check the BaseHandle instance has body or not.
 431         /// </summary>
 432         /// <returns>True If the baseHandle instance has body.</returns>
 433         /// <since_tizen> 3 </since_tizen>
 434         public bool HasBody()
 435         {
 436             if (swigCPtrCopy.Handle == IntPtr.Zero)
 437             {
 438                 return false;
 439             }
 440
 441             if (disposed == true)
 442             {
 443                 return false;
 444             }
 445             bool ret = Interop.BaseHandle.HasBody(swigCPtrCopy);
 446             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 447             return ret;
 448         }
 449
 450         /// <summary>
 451         /// To check the BaseHandle instance is equal or not.
 452         /// </summary>
 453         /// <param name="rhs">The baseHandle instance.</param>
 454         /// <returns>True If equal.</returns>
 455         /// <since_tizen> 3 </since_tizen>
 456         public bool IsEqual(BaseHandle rhs)
 457         {
 458             if (disposed == true)
 459             {
 460                 return false;
 461             }
 462
 463             bool ret = Interop.BaseHandle.IsEqual(swigCPtrCopy, BaseHandle.getCPtr(rhs));
 464             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 465             return ret;
 466         }
 467
 468         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(BaseHandle obj)
 469         {
 470             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtrCopy;
 471         }
 472
 473         internal void NotifyPropertyChanged([CallerMemberName] String propertyName = "")
 474         {
 475             PropertySet?.Invoke(this, new PropertyChangedEventArgs(propertyName));
 476         }
 477
 478         /// <summary>
 479         /// Dispose.
 480         /// </summary>
 481         /// <since_tizen> 3 </since_tizen>
 482         protected virtual void Dispose(DisposeTypes type)
 483         {
 484             if (disposed)
 485             {
 486                 return;
 487             }
 488
 489             if (type == DisposeTypes.Explicit)
 490             {
 491                 //Called by User
 492                 //Release your own managed resources here.
 493                 //You should release all of your own disposable objects here.
 494
 495             }
 496
 497             //Release your own unmanaged resources here.
 498             //You should not access any managed member here except static instance.
 499             //because the execution order of Finalizes is non-deterministic.
 500
 501             //Unreference this instance from Registry.
 502             if (registerMe)
 503             {
 504                 Registry.Unregister(this);
 505             }
 506
 507             if (SwigCPtr.Handle != IntPtr.Zero)
 508             {
 509                 if (swigCMemOwn)
 510                 {
 511                     swigCMemOwn = false;
 512                     ReleaseSwigCPtr(SwigCPtr);
 513                 }
 514                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
 515             }
 516             if (swigCPtrCopy.Handle != global::System.IntPtr.Zero)
 517             {
 518                 swigCMemOwn = false;
 519                 Interop.BaseHandle.DeleteBaseHandle(swigCPtrCopy);
 520                 swigCPtrCopy = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
 521             }
 522
 523             disposed = true;
 524
 525             if (null != Application.Current)
 526             {
 527                 Application.Current.XamlResourceChanged -= OnResourcesChanged;
 528             }
 529         }
 530
 531         /// <summary>
 532         /// Release swigCPtr.
 533         /// </summary>
 534         /// <since_tizen> 6 </since_tizen>
 535         /// This will not be public opened.
 536         [EditorBrowsable(EditorBrowsableState.Never)]
 537         protected virtual void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
 538         {
 539         }
 540
 541         /// <summary>
 542         /// Contains event arguments for the FocusChangeRequested event.
 543         /// </summary>
 544         [Obsolete("Deprecated in API9; Will be removed in API11.")]
 545         public class FocusRequestArgs : EventArgs
 546         {
 547
 548             /// <summary>
 549             /// Gets or sets a value that indicates the starting focus state of the element for which a focus change is requested.
 550             /// </summary>
 551             public bool Focus { get; set; }
 552
 553             /// <summary>
 554             /// Gets or sets a value that indicates the ending focus state of the element for which a focus change is requested.
 555             /// </summary>
 556             public bool Result { get; set; }
 557         }
 558
 559         internal global::System.Runtime.InteropServices.HandleRef SwigCPtr
 560         {
 561             get => swigCPtr;
 562             set
 563             {
 564                 swigCPtr = value;
 565             }
 566         }
 567
 568         /// <summary>
 569         /// swigCMemOwn
 570         /// </summary>
 571         [EditorBrowsable(EditorBrowsableState.Never)]
 572         protected internal bool SwigCMemOwn => swigCMemOwn;
 573
 574         /// <summary>
 575         /// A flag to check if it is already disposed.
 576         /// </summary>
 577         [EditorBrowsable(EditorBrowsableState.Never)]
 578         protected internal bool Disposed => disposed;
 579     }
 580 }