Skip to content

Default implementation for IV8FastHostObjectOperations #683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
AnsisMalins wants to merge 1 commit into from
Closed

Default implementation for IV8FastHostObjectOperations #683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 67 additions & 13 deletions ClearScript/V8/FastProxy/IV8FastHostObjectOperations.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using Microsoft.ClearScript.Util;
using System;
using System.Collections.Generic;

namespace Microsoft.ClearScript.V8.FastProxy
Expand All @@ -15,7 +17,11 @@ public interface IV8FastHostObjectOperations
/// </summary>
/// <param name="instance">The object for which to get a human-readable name.</param>
/// <returns>A human-readable name for the specified object.</returns>
string GetFriendlyName(IV8FastHostObject instance);
string GetFriendlyName(IV8FastHostObject instance)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> $"FastHostObject:{GetType().GetFriendlyName()}"
#endif
;

/// <summary>
/// Gets the value of a named property.
Expand All @@ -24,90 +30,138 @@ public interface IV8FastHostObjectOperations
/// <param name="name">The name of the property to get.</param>
/// <param name="value">On return, the value of the property if it was found.</param>
/// <param name="isCacheable">On return, <c>true</c> if the property value is a cacheable constant, <c>false</c> otherwise.</param>
void GetProperty(IV8FastHostObject instance, string name, in V8FastResult value, out bool isCacheable);
void GetProperty(IV8FastHostObject instance, string name, in V8FastResult value, out bool isCacheable)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException($"Named property {name} is not implemented")
#endif
;

/// <summary>
/// Sets the value of a named property.
/// </summary>
/// <param name="instance">The object whose property to set.</param>
/// <param name="name">The name of the property to set.</param>
/// <param name="value">The property value.</param>
void SetProperty(IV8FastHostObject instance, string name, in V8FastArg value);
void SetProperty(IV8FastHostObject instance, string name, in V8FastArg value)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException($"Named property {name} is not implemented")
#endif
;

/// <summary>
/// Gets the attributes of a named property.
/// </summary>
/// <param name="instance">The object to search for the property.</param>
/// <param name="name">The name of the property to query.</param>
/// <returns>A set of property attributes.</returns>
V8FastHostPropertyFlags QueryProperty(IV8FastHostObject instance, string name);
V8FastHostPropertyFlags QueryProperty(IV8FastHostObject instance, string name)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException($"Named property {name} is not implemented")
#endif
;

/// <summary>
/// Deletes a named property.
/// </summary>
/// <param name="instance">The object whose property to delete.</param>
/// <param name="name">The name of the property to delete.</param>
/// <returns><c>True</c> if the property was deleted or does not exist; <c>false</c> if the property exists but is not deletable.</returns>
bool DeleteProperty(IV8FastHostObject instance, string name);
bool DeleteProperty(IV8FastHostObject instance, string name)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException($"Named property {name} is not implemented")
#endif
;

/// <summary>
/// Enumerates the names of all existing named properties.
/// </summary>
/// <param name="instance">The object to search for named properties.</param>
/// <returns>A collection containing the names of all existing named properties.</returns>
IEnumerable<string> GetPropertyNames(IV8FastHostObject instance);
IEnumerable<string> GetPropertyNames(IV8FastHostObject instance)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException("Listing named properties is not implemented")
#endif
;

/// <summary>
/// Gets the value of an indexed property.
/// </summary>
/// <param name="instance">The object to search for the property.</param>
/// <param name="index">The index of the property to get.</param>
/// <param name="value">On return, the value of the property if it was found.</param>
void GetProperty(IV8FastHostObject instance, int index, in V8FastResult value);
void GetProperty(IV8FastHostObject instance, int index, in V8FastResult value)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException($"Indexed property {index} is not implemented")
#endif
;

/// <summary>
/// Sets the value of an indexed property.
/// </summary>
/// <param name="instance">The object whose property to set.</param>
/// <param name="index">The index of the property to set.</param>
/// <param name="value">The property value.</param>
void SetProperty(IV8FastHostObject instance, int index, in V8FastArg value);
void SetProperty(IV8FastHostObject instance, int index, in V8FastArg value)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException($"Indexed property {index} is not implemented")
#endif
;

/// <summary>
/// Gets the attributes of an indexed property.
/// </summary>
/// <param name="instance">The object to search for the property.</param>
/// <param name="index">The index of the property to query.</param>
/// <returns>A set of property attributes.</returns>
V8FastHostPropertyFlags QueryProperty(IV8FastHostObject instance, int index);
V8FastHostPropertyFlags QueryProperty(IV8FastHostObject instance, int index)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException($"Indexed property {index} is not implemented")
#endif
;

/// <summary>
/// Deletes an indexed property.
/// </summary>
/// <param name="instance">The object whose property to delete.</param>
/// <param name="index">The index of the property to delete.</param>
/// <returns><c>True</c> if the property was deleted or does not exist; <c>false</c> if the property exists but is not deletable.</returns>
bool DeleteProperty(IV8FastHostObject instance, int index);
bool DeleteProperty(IV8FastHostObject instance, int index)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException($"Indexed property {index} is not implemented")
#endif
;

/// <summary>
/// Enumerates the indices of all existing indexed properties.
/// </summary>
/// <param name="instance">The object to search for indexed properties.</param>
/// <returns>A collection containing the indices of all existing indexed properties.</returns>
IEnumerable<int> GetPropertyIndices(IV8FastHostObject instance);
IEnumerable<int> GetPropertyIndices(IV8FastHostObject instance)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException("Listing indexed properties is not implemented")
#endif
;

/// <summary>
/// Creates a fast enumerator that iterates through the object's contents.
/// </summary>
/// <param name="instance">The object for which to create a fast enumerator.</param>
/// <returns>A fast enumerator for the specified object's contents.</returns>
IV8FastEnumerator CreateEnumerator(IV8FastHostObject instance);
IV8FastEnumerator CreateEnumerator(IV8FastHostObject instance)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException("Enumerator is not implemented")
#endif
;

/// <summary>
/// Creates a fast asynchronous enumerator that iterates through the object's contents.
/// </summary>
/// <param name="instance">The object for which to create a fast asynchronous enumerator.</param>
/// <returns>A fast asynchronous enumerator for the specified object's contents.</returns>
IV8FastAsyncEnumerator CreateAsyncEnumerator(IV8FastHostObject instance);
IV8FastAsyncEnumerator CreateAsyncEnumerator(IV8FastHostObject instance)
#if NETCOREAPP3_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER || UNITY_2022_3_OR_NEWER
=> throw new NotImplementedException("Async enumerator is not implemented")
#endif
;
}
}