csharp: updating eina_inarray docs and hide api.
Reviewers: lauromoura, felipealmeida, segfaultxavi, woohyun Reviewed By: lauromoura Subscribers: cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T8293 Differential Revision: https://phab.enlightenment.org/D10328
This commit is contained in:
parent
14a6611f23
commit
fe93c519ab
|
@ -3,6 +3,7 @@
|
||||||
using System;
|
using System;
|
||||||
using System.Runtime.InteropServices;
|
using System.Runtime.InteropServices;
|
||||||
using System.Collections.Generic;
|
using System.Collections.Generic;
|
||||||
|
using System.ComponentModel;
|
||||||
|
|
||||||
using static Eina.TraitFunctions;
|
using static Eina.TraitFunctions;
|
||||||
using static Eina.InarrayNativeFunctions;
|
using static Eina.InarrayNativeFunctions;
|
||||||
|
@ -10,6 +11,7 @@ using static Eina.InarrayNativeFunctions;
|
||||||
namespace Eina
|
namespace Eina
|
||||||
{
|
{
|
||||||
|
|
||||||
|
[EditorBrowsable(EditorBrowsableState.Never)]
|
||||||
public static class InarrayNativeFunctions
|
public static class InarrayNativeFunctions
|
||||||
{
|
{
|
||||||
[DllImport(efl.Libs.Eina)] public static extern IntPtr
|
[DllImport(efl.Libs.Eina)] public static extern IntPtr
|
||||||
|
@ -68,17 +70,25 @@ public static class InarrayNativeFunctions
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Wrapper around an inplace array.
|
/// <summary>Wrapper around an inplace array.
|
||||||
///
|
/// <para>Since EFL 1.23.</para>
|
||||||
/// Since EFL 1.23.
|
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class Inarray<T> : IEnumerable<T>, IDisposable
|
public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
{
|
{
|
||||||
public static uint DefaultStep = 0;
|
public static uint DefaultStep = 0;
|
||||||
|
[EditorBrowsable(EditorBrowsableState.Never)]
|
||||||
public IntPtr Handle {get;set;} = IntPtr.Zero;
|
public IntPtr Handle {get;set;} = IntPtr.Zero;
|
||||||
|
/// <summary>Whether this wrapper owns the native buffer.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public bool Own {get;set;}
|
public bool Own {get;set;}
|
||||||
|
/// <summary>Who is in charge of releasing the resources wrapped by
|
||||||
|
/// this instance.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public bool OwnContent {get;set;}
|
public bool OwnContent {get;set;}
|
||||||
|
/// <summary> Length of the array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public int Length
|
public int Length
|
||||||
{
|
{
|
||||||
get { return Count(); }
|
get { return Count(); }
|
||||||
|
@ -96,16 +106,26 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Default constructor
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public Inarray()
|
public Inarray()
|
||||||
{
|
{
|
||||||
InitNew(DefaultStep);
|
InitNew(DefaultStep);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Constructor with step.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="step">Step size of the array.</param>
|
||||||
public Inarray(uint step)
|
public Inarray(uint step)
|
||||||
{
|
{
|
||||||
InitNew(step);
|
InitNew(step);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[EditorBrowsable(EditorBrowsableState.Never)]
|
||||||
public Inarray(IntPtr handle, bool own)
|
public Inarray(IntPtr handle, bool own)
|
||||||
{
|
{
|
||||||
Handle = handle;
|
Handle = handle;
|
||||||
|
@ -113,6 +133,7 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
OwnContent = own;
|
OwnContent = own;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[EditorBrowsable(EditorBrowsableState.Never)]
|
||||||
public Inarray(IntPtr handle, bool own, bool ownContent)
|
public Inarray(IntPtr handle, bool own, bool ownContent)
|
||||||
{
|
{
|
||||||
Handle = handle;
|
Handle = handle;
|
||||||
|
@ -120,11 +141,20 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
OwnContent = ownContent;
|
OwnContent = ownContent;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Finalizer to be called from the Garbage Collector.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
~Inarray()
|
~Inarray()
|
||||||
{
|
{
|
||||||
Dispose(false);
|
Dispose(false);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>Disposes of this wrapper, releasing the native array if owned.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="disposing">True if this was called from <see cref="Dispose()"/> public method. False if
|
||||||
|
/// called from the C# finalizer.</param>
|
||||||
protected virtual void Dispose(bool disposing)
|
protected virtual void Dispose(bool disposing)
|
||||||
{
|
{
|
||||||
IntPtr h = Handle;
|
IntPtr h = Handle;
|
||||||
|
@ -156,17 +186,28 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>Releases the native resources held by this instance.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public void Dispose()
|
public void Dispose()
|
||||||
{
|
{
|
||||||
Dispose(true);
|
Dispose(true);
|
||||||
GC.SuppressFinalize(this);
|
GC.SuppressFinalize(this);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>Releases the native resources held by this instance.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public void Free()
|
public void Free()
|
||||||
{
|
{
|
||||||
Dispose();
|
Dispose();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Releases the native array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <returns>The native array.</returns>
|
||||||
public IntPtr Release()
|
public IntPtr Release()
|
||||||
{
|
{
|
||||||
IntPtr h = Handle;
|
IntPtr h = Handle;
|
||||||
|
@ -186,29 +227,54 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Removes every member from the array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public void Flush()
|
public void Flush()
|
||||||
{
|
{
|
||||||
FreeElementsIfOwned();
|
FreeElementsIfOwned();
|
||||||
eina_inarray_flush(Handle);
|
eina_inarray_flush(Handle);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Counts the number of members in an array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <returns>THe number of members in the array.</returns>
|
||||||
public int Count()
|
public int Count()
|
||||||
{
|
{
|
||||||
return (int)eina_inarray_count(Handle);
|
return (int)eina_inarray_count(Handle);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>Sets all ownership.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="ownAll">If the hash own for all ownerships.</param>
|
||||||
public void SetOwnership(bool ownAll)
|
public void SetOwnership(bool ownAll)
|
||||||
{
|
{
|
||||||
Own = ownAll;
|
Own = ownAll;
|
||||||
OwnContent = ownAll;
|
OwnContent = ownAll;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>Sets own individually.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="own">If own the object.</param>
|
||||||
|
/// <param name="ownContent">If own the content's object.</param>
|
||||||
public void SetOwnership(bool own, bool ownContent)
|
public void SetOwnership(bool own, bool ownContent)
|
||||||
{
|
{
|
||||||
Own = own;
|
Own = own;
|
||||||
OwnContent = ownContent;
|
OwnContent = ownContent;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Puts the value as the last member of the array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="val">The value to be pushed.</param>
|
||||||
|
/// <returns>The index of the new member, otherwise -1 on errors.</returns>
|
||||||
public int Push(T val)
|
public int Push(T val)
|
||||||
{
|
{
|
||||||
IntPtr ele = IntPtr.Zero;
|
IntPtr ele = IntPtr.Zero;
|
||||||
|
@ -237,6 +303,11 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
// }
|
// }
|
||||||
// }
|
// }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Removes the last member of the array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <returns>The data poppep out of the array.</returns>
|
||||||
public T Pop()
|
public T Pop()
|
||||||
{
|
{
|
||||||
IntPtr ele = eina_inarray_pop(Handle);
|
IntPtr ele = eina_inarray_pop(Handle);
|
||||||
|
@ -249,17 +320,36 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
return r;
|
return r;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets the member at the given position.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="idx">The member position.</param>
|
||||||
|
/// <returns>The element of the given position.</returns>
|
||||||
public T Nth(uint idx)
|
public T Nth(uint idx)
|
||||||
{
|
{
|
||||||
IntPtr ele = eina_inarray_nth(Handle, idx);
|
IntPtr ele = eina_inarray_nth(Handle, idx);
|
||||||
return NativeToManagedInplace<T>(ele);
|
return NativeToManagedInplace<T>(ele);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets the member at the given position.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="idx">The member position.</param>
|
||||||
|
/// <returns>The element of the given position.</returns>
|
||||||
public T At(int idx)
|
public T At(int idx)
|
||||||
{
|
{
|
||||||
return Nth((uint)idx);
|
return Nth((uint)idx);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Inserts the value at the given position in the array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="idx">The position to insert the member at.</param>
|
||||||
|
/// <param name="val">The value to be inserted.</param>
|
||||||
|
/// <returns> true on success, false on failure.</returns>
|
||||||
public bool InsertAt(uint idx, T val)
|
public bool InsertAt(uint idx, T val)
|
||||||
{
|
{
|
||||||
IntPtr ele = IntPtr.Zero;
|
IntPtr ele = IntPtr.Zero;
|
||||||
|
@ -278,6 +368,12 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
return r;
|
return r;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Replaces the value at the given position.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="idx">The position to replace the member at.</param>
|
||||||
|
/// <param name="val">The value to replace.</param>
|
||||||
public bool ReplaceAt(uint idx, T val)
|
public bool ReplaceAt(uint idx, T val)
|
||||||
{
|
{
|
||||||
var old = eina_inarray_nth(Handle, idx);
|
var old = eina_inarray_nth(Handle, idx);
|
||||||
|
@ -302,6 +398,9 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
return r;
|
return r;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary> Accessor by index to the elements of this list.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public T this[int idx]
|
public T this[int idx]
|
||||||
{
|
{
|
||||||
get
|
get
|
||||||
|
@ -314,6 +413,12 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Removes a member from the given position.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="idx">The position to remove the member at.</param>
|
||||||
|
/// <returns>true on success, false on failure.</returns>
|
||||||
public bool RemoveAt(uint idx)
|
public bool RemoveAt(uint idx)
|
||||||
{
|
{
|
||||||
IntPtr ele = eina_inarray_nth(Handle, idx);
|
IntPtr ele = eina_inarray_nth(Handle, idx);
|
||||||
|
@ -330,11 +435,20 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
return eina_inarray_remove_at(Handle, idx);
|
return eina_inarray_remove_at(Handle, idx);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Reverses members in the array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public void Reverse()
|
public void Reverse()
|
||||||
{
|
{
|
||||||
eina_inarray_reverse(Handle);
|
eina_inarray_reverse(Handle);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Returns a array containing all of the elements in proper sequence.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <returns>A array</returns>
|
||||||
public T[] ToArray()
|
public T[] ToArray()
|
||||||
{
|
{
|
||||||
int len = Length;
|
int len = Length;
|
||||||
|
@ -347,6 +461,10 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
return managed;
|
return managed;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary> Appends all elements at the end of array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
|
/// <returns>true on success, false otherwise.</returns>
|
||||||
public bool Append(T[] values)
|
public bool Append(T[] values)
|
||||||
{
|
{
|
||||||
foreach (T v in values)
|
foreach (T v in values)
|
||||||
|
@ -360,16 +478,25 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary> Gets an Iterator for this Array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public Eina.Iterator<T> GetIterator()
|
public Eina.Iterator<T> GetIterator()
|
||||||
{
|
{
|
||||||
return new Eina.Iterator<T>(eina_inarray_iterator_new(Handle), true);
|
return new Eina.Iterator<T>(eina_inarray_iterator_new(Handle), true);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary> Gets an Iterator for this Array with reversed order.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public Eina.Iterator<T> GetReversedIterator()
|
public Eina.Iterator<T> GetReversedIterator()
|
||||||
{
|
{
|
||||||
return new Eina.Iterator<T>(eina_inarray_iterator_reversed_new(Handle), true);
|
return new Eina.Iterator<T>(eina_inarray_iterator_reversed_new(Handle), true);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary> Gets an Enumerator for this Array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public IEnumerator<T> GetEnumerator()
|
public IEnumerator<T> GetEnumerator()
|
||||||
{
|
{
|
||||||
int len = Length;
|
int len = Length;
|
||||||
|
@ -384,7 +511,9 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
|
||||||
return this.GetEnumerator();
|
return this.GetEnumerator();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary> Gets an Accessor for this Array.</summary>
|
/// <summary> Gets an Accessor for this Array.
|
||||||
|
/// <para>Since EFL 1.23.</para>
|
||||||
|
/// </summary>
|
||||||
public Eina.Accessor<T> GetAccessor()
|
public Eina.Accessor<T> GetAccessor()
|
||||||
{
|
{
|
||||||
return new Eina.AccessorInArray<T>(eina_inarray_accessor_new(Handle), Ownership.Managed);
|
return new Eina.AccessorInArray<T>(eina_inarray_accessor_new(Handle), Ownership.Managed);
|
||||||
|
|
Loading…
Reference in New Issue