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