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

   1 /*
   2  * Copyright(c) 2022 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, 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         /// The flag to check if it is already disposed of.
  40         /// </summary>
  41         /// <since_tizen> 3 </since_tizen>
  42         [Obsolete("Deprecated in API9, will be removed in API11, 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         //The 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, 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                     var process = global::System.Diagnostics.Process.GetCurrentProcess().Id;
 334                     var thread = global::System.Threading.Thread.CurrentThread.ManagedThreadId;
 335                     var me = this.GetType().FullName;
 336
 337                     throw new global::System.InvalidOperationException("[NUI][BaseHandle] This API called from separate thread. This API must be called from MainThread. \n" +
 338                         $" process:{process} thread:{thread}, disposing:{disposing}, isDisposed:{this.disposed}, isDisposeQueued:{this.isDisposeQueued}, me:{me}\n");
 339                 }
 340
 341                 Dispose(DisposeTypes.Explicit);
 342             }
 343             else
 344             {
 345                 // Implicit call. user doesn't call Dispose(), so this object is added into DisposeQueue to be disposed automatically.
 346                 if (!isDisposeQueued)
 347                 {
 348                     isDisposeQueued = true;
 349                     DisposeQueue.Instance.Add(this);
 350                 }
 351             }
 352
 353             // TODO: free unmanaged resources (unmanaged objects) and override a finalizer below.
 354             // TODO: set large fields to null.
 355         }
 356
 357
 358         /// <summary>
 359         /// Performs an action on this object with the given action name and attributes.
 360         /// </summary>
 361         /// <param name="actionName">The command for the action.</param>
 362         /// <param name="attributes">The list of attributes for the action.</param>
 363         /// <returns>The action is performed by the object or not.</returns>
 364         /// <since_tizen> 3 </since_tizen>
 365         public bool DoAction(string actionName, PropertyMap attributes)
 366         {
 367             bool ret = Interop.BaseHandle.DoAction(swigCPtrCopy, actionName, PropertyMap.getCPtr(attributes));
 368             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 369             return ret;
 370         }
 371
 372         /// <summary>
 373         /// Returns the type name for the Handle.<br />
 374         /// Will return an empty string if the typename does not exist. This will happen for types that
 375         /// have not registered with type-registry.
 376         /// </summary>
 377         /// <returns>The type name. Empty string if the typename does not exist.</returns>
 378         /// <since_tizen> 3 </since_tizen>
 379         public string GetTypeName()
 380         {
 381             string ret = Interop.BaseHandle.GetTypeName(swigCPtrCopy);
 382             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 383             return ret;
 384         }
 385
 386         /// <summary>
 387         /// Returns the type info for the Handle.<br />
 388         /// </summary>
 389         /// <param name="info">The type information.</param>
 390         /// <returns>True If get the type info.</returns>
 391         /// <since_tizen> 3 </since_tizen>
 392         public bool GetTypeInfo(Tizen.NUI.TypeInfo info)
 393         {
 394             bool ret = Interop.BaseHandle.GetTypeInfo(swigCPtrCopy, Tizen.NUI.TypeInfo.getCPtr(info));
 395             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 396             return ret;
 397         }
 398
 399         /// <summary>
 400         /// Resets the handle.
 401         /// </summary>
 402         /// <since_tizen> 3 </since_tizen>
 403         public void Reset()
 404         {
 405             Interop.BaseHandle.Reset(swigCPtrCopy);
 406             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 407         }
 408
 409         /// <summary>
 410         /// To check the BaseHandle instance is equal or not.
 411         /// </summary>
 412         /// <param name="rhs">The baseHandle instance.</param>
 413         /// <returns>True If equal.</returns>
 414         /// <since_tizen> 3 </since_tizen>
 415         public bool EqualTo(BaseHandle rhs)
 416         {
 417             bool ret = Interop.BaseHandle.EqualTo(swigCPtrCopy, BaseHandle.getCPtr(rhs));
 418             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 419             return ret;
 420         }
 421
 422         /// <summary>
 423         /// To check the BaseHandle instance is equal or not.
 424         /// </summary>
 425         /// <param name="rhs">The baseHandle instance.</param>
 426         /// <returns>True If not equal.</returns>
 427         /// <since_tizen> 3 </since_tizen>
 428         public bool NotEqualTo(BaseHandle rhs)
 429         {
 430             bool ret = Interop.BaseHandle.NotEqualTo(swigCPtrCopy, BaseHandle.getCPtr(rhs));
 431             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 432             return ret;
 433         }
 434
 435         /// <summary>
 436         /// To check the BaseHandle instance has body or not.
 437         /// </summary>
 438         /// <returns>True If the baseHandle instance has body.</returns>
 439         /// <since_tizen> 3 </since_tizen>
 440         public bool HasBody()
 441         {
 442             if (swigCPtrCopy.Handle == IntPtr.Zero)
 443             {
 444                 return false;
 445             }
 446
 447             if (disposed == true)
 448             {
 449                 return false;
 450             }
 451             bool ret = Interop.BaseHandle.HasBody(swigCPtrCopy);
 452             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 453             return ret;
 454         }
 455
 456         /// <summary>
 457         /// To check the BaseHandle instance is equal or not.
 458         /// </summary>
 459         /// <param name="rhs">The baseHandle instance.</param>
 460         /// <returns>True If equal.</returns>
 461         /// <since_tizen> 3 </since_tizen>
 462         public bool IsEqual(BaseHandle rhs)
 463         {
 464             if (disposed == true)
 465             {
 466                 return false;
 467             }
 468
 469             bool ret = Interop.BaseHandle.IsEqual(swigCPtrCopy, BaseHandle.getCPtr(rhs));
 470             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 471             return ret;
 472         }
 473
 474         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(BaseHandle obj)
 475         {
 476             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtrCopy;
 477         }
 478
 479         internal void NotifyPropertyChanged([CallerMemberName] String propertyName = "")
 480         {
 481             PropertySet?.Invoke(this, new PropertyChangedEventArgs(propertyName));
 482         }
 483
 484         /// <summary>
 485         /// Dispose.
 486         /// </summary>
 487         /// <since_tizen> 3 </since_tizen>
 488         protected virtual void Dispose(DisposeTypes type)
 489         {
 490             if (disposed)
 491             {
 492                 return;
 493             }
 494
 495             if (type == DisposeTypes.Explicit)
 496             {
 497                 //Called by User
 498                 //Release your own managed resources here.
 499                 //You should release all of your own disposable objects here.
 500
 501             }
 502
 503             //Release your own unmanaged resources here.
 504             //You should not access any managed member here except static instance.
 505             //because the execution order of Finalizes is non-deterministic.
 506
 507             //Unreference this instance from Registry.
 508             if (registerMe)
 509             {
 510                 Registry.Unregister(this);
 511             }
 512
 513             if (SwigCPtr.Handle != IntPtr.Zero)
 514             {
 515                 if (swigCMemOwn)
 516                 {
 517                     swigCMemOwn = false;
 518                     ReleaseSwigCPtr(SwigCPtr);
 519                 }
 520                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
 521             }
 522             else
 523             {
 524                 var me = this.GetType().FullName;
 525                 Log.Error("NUI", $"[ERR] SwigCPtr is NULL, need to check! me:{me}");
 526             }
 527
 528             if (swigCPtrCopy.Handle != global::System.IntPtr.Zero)
 529             {
 530                 swigCMemOwn = false;
 531                 Interop.BaseHandle.DeleteBaseHandle(swigCPtrCopy);
 532                 swigCPtrCopy = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
 533             }
 534             else
 535             {
 536                 var me = this.GetType().FullName;
 537                 Log.Error("NUI", $"[ERR] swigCPtrCopy is NULL, need to check! me:{me}");
 538             }
 539
 540             disposed = true;
 541         }
 542
 543         /// <summary>
 544         /// Release swigCPtr.
 545         /// </summary>
 546         /// <since_tizen> 6 </since_tizen>
 547         /// This will not be public opened.
 548         [EditorBrowsable(EditorBrowsableState.Never)]
 549         protected virtual void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
 550         {
 551         }
 552
 553         /// <summary>
 554         /// Contains event arguments for the FocusChangeRequested event.
 555         /// </summary>
 556         [Obsolete("Deprecated in API9; Will be removed in API11.")]
 557         public class FocusRequestArgs : EventArgs
 558         {
 559
 560             /// <summary>
 561             /// Gets or sets a value that indicates the starting focus state of the element for which a focus change is requested.
 562             /// </summary>
 563             public bool Focus { get; set; }
 564
 565             /// <summary>
 566             /// Gets or sets a value that indicates the ending focus state of the element for which a focus change is requested.
 567             /// </summary>
 568             public bool Result { get; set; }
 569         }
 570
 571         internal global::System.Runtime.InteropServices.HandleRef SwigCPtr
 572         {
 573             get
 574             {
 575                 if (swigCPtr.Handle == IntPtr.Zero)
 576                 {
 577                     var me = this.GetType().FullName;
 578                     Log.Fatal("NUI", $"Error! swigCPtr.Handle == IntPtr.Zero ! please check! me:{me}\n");
 579                 }
 580                 return swigCPtr;
 581             }
 582         }
 583
 584         internal bool IsNativeHandleInvalid()
 585         {
 586             return swigCPtr.Handle == IntPtr.Zero;
 587         }
 588
 589         /// <summary>
 590         /// swigCMemOwn
 591         /// </summary>
 592         [EditorBrowsable(EditorBrowsableState.Never)]
 593         protected internal bool SwigCMemOwn => swigCMemOwn;
 594
 595         /// <summary>
 596         /// The flag to check if it is already disposed of.
 597         /// </summary>
 598         [EditorBrowsable(EditorBrowsableState.Never)]
 599         protected internal bool Disposed => disposed;
 600
 601         /// <summary>
 602         /// The flag to check if it is disposed by DisposeQueue.
 603         /// </summary>
 604         [EditorBrowsable(EditorBrowsableState.Never)]
 605         protected internal bool IsDisposeQueued => isDisposeQueued;
 606
 607     }
 608 }