kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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:
Bruno da Silva Belo 2019-10-10 00:52:26 -03:00 committed by Lauro Moura
parent 14a6611f23
commit fe93c519ab
1 changed files with 134 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
src/bindings/mono/eina_mono/eina_inarray.cs
View File

@ -3,6 +3,7 @@
using System;
using System.Runtime.InteropServices;
using System.Collections.Generic;
using System.ComponentModel;
using static Eina.TraitFunctions;
using static Eina.InarrayNativeFunctions;
@ -10,6 +11,7 @@ using static Eina.InarrayNativeFunctions;
namespace Eina
{
[EditorBrowsable(EditorBrowsableState.Never)]
public static class InarrayNativeFunctions
{
[DllImport(efl.Libs.Eina)] public static extern IntPtr
@ -68,17 +70,25 @@ public static class InarrayNativeFunctions
}
/// <summary>Wrapper around an inplace array.
///
/// Since EFL 1.23.
/// <para>Since EFL 1.23.</para>
/// </summary>
public class Inarray<T> : IEnumerable<T>, IDisposable
{
public static uint DefaultStep = 0;
[EditorBrowsable(EditorBrowsableState.Never)]
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;}
/// <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;}
/// <summary> Length of the array.
/// <para>Since EFL 1.23.</para>
/// </summary>
public int Length
{
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()
{
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)
{
InitNew(step);
}
[EditorBrowsable(EditorBrowsableState.Never)]
public Inarray(IntPtr handle, bool own)
{
Handle = handle;
@ -113,6 +133,7 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
OwnContent = own;
}
[EditorBrowsable(EditorBrowsableState.Never)]
public Inarray(IntPtr handle, bool own, bool ownContent)
{
Handle = handle;
@ -120,11 +141,20 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
OwnContent = ownContent;
}
/// <summary>
/// Finalizer to be called from the Garbage Collector.
/// <para>Since EFL 1.23.</para>
/// </summary>
~Inarray()
{
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)
{
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()
{
Dispose(true);
GC.SuppressFinalize(this);
}
/// <summary>Releases the native resources held by this instance.
/// <para>Since EFL 1.23.</para>
/// </summary>
public void Free()
{
Dispose();
}
/// <summary>
/// Releases the native array.
/// <para>Since EFL 1.23.</para>
/// </summary>
/// <returns>The native array.</returns>
public IntPtr Release()
{
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()
{
FreeElementsIfOwned();
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()
{
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)
{
Own = 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)
{
Own = own;
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)
{
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()
{
IntPtr ele = eina_inarray_pop(Handle);
@ -249,17 +320,36 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
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)
{
IntPtr ele = eina_inarray_nth(Handle, idx);
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)
{
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)
{
IntPtr ele = IntPtr.Zero;
@ -278,6 +368,12 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
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)
{
var old = eina_inarray_nth(Handle, idx);
@ -302,6 +398,9 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
return r;
}
/// <summary> Accessor by index to the elements of this list.
/// <para>Since EFL 1.23.</para>
/// </summary>
public T this[int idx]
{
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)
{
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);
}
/// <summary>
/// Reverses members in the array.
/// <para>Since EFL 1.23.</para>
/// </summary>
public void Reverse()
{
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()
{
int len = Length;
@ -347,6 +461,10 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
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)
{
foreach (T v in values)
@ -360,16 +478,25 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
return true;
}
/// <summary> Gets an Iterator for this Array.
/// <para>Since EFL 1.23.</para>
/// </summary>
public Eina.Iterator<T> GetIterator()
{
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()
{
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()
{
int len = Length;
@ -384,7 +511,9 @@ public class Inarray<T> : IEnumerable<T>, IDisposable
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()
{
return new Eina.AccessorInArray<T>(eina_inarray_accessor_new(Handle), Ownership.Managed);