Blacklisted class macro

Macro that automatically generates fields for use in sandboxed classes.

Author: NotHyper-474

source/funkin/util/ReflectUtil.hx

@@ -1,41 +1,64 @@
 package funkin.util;
 
-import Type.ValueType;
-
 /**
  * Provides sanitized and blacklisted access to haxe's Reflection functions.
  * Used for sandboxing in scripts.
  */
 @:nullSafety
 @SuppressWarnings("checkstyle:VarTypeHint")
+@:build(funkin.util.macro.BlacklistClassMacro.build(
+  {
+    classes: ["Reflect", "Type"],
+    aliases:
+      {
+        "setAnonymousField": ["setField"],
+        "getAnonymousField": ["field", "getField"],
+        "getAnonymousFieldsOf": ["fields", "getFieldsOf"],
+        "copyAnonymousFieldsOf": ["copy"],
+        "hasAnonymousField": ["hasField"],
+        "deleteAnonymousField": ["delete", "deleteField"],
+        "compareValues": ["compare"]
+      },
+    whitelist: [
+      "isEnumValue",
+      "compareMethods",
+      "isFunction",
+      "isObject",
+      "getClassFields",
+      "getInstanceFields",
+      "getClassName",
+      "getEnumName",
+      "setProperty"
+    ]
+  }))
 class ReflectUtil
 {
   /**
    * A list of field names which cannot be retrieved with `getAnonymousField()`
+   *
+   * This should always be a property so that scripts won't be able to change it.
    */
-  static final FIELD_NAME_BLACKLIST:Array<String> = ['_interp'];
+  static var FIELD_NAME_BLACKLIST(get, never):Array<String>;
+
+  static function get_FIELD_NAME_BLACKLIST():Array<String>
+  {
+    return ['_interp'];
+  }
 
   /**
    * This function is not allowed to be used by scripts.
    * @throws error When called by a script.
    */
-  @SuppressWarnings("checkstyle:FieldDocComment")
-  public static function callMethod(obj:Any, name:String, args:Array<Any>):Any
-  {
-    throw "Function Reflect.callMethod is blacklisted.";
-  }
-
+  // public static function callMethod(obj:Any, name:String, args:Array<Any>):Any
   /**
    * Compares two objects by value.
    *
+   * The actual function exists and is generated at build time.
    * @param valueA First value to compare
    * @param valueB Second value to compare
    * @return Int indicating relative order of values
    */
-  public static function compare(valueA:Any, valueB:Any):Int
-  {
-    return compareValues(valueA, valueB);
-  }
+  // public static function compare(valueA:Any, valueB:Any):Int
 
   /**
    * Compares two values and returns an integer indicating their relative order.
@@ -59,21 +82,16 @@ class ReflectUtil
    * @param functionB A method closure to compare.
    * @return Whether functionA and functionB are equal.
    */
-  public static function compareMethods(functionA:Any, functionB:Any):Bool
-  {
-    return Reflect.compareMethods(functionA, functionB);
-  }
-
+  // public static function compareMethods(functionA:Any, functionB:Any):Bool
   /**
    * Copies the given object.
    * Only guaranteed to work on anonymous structures.
+   *
+   * The actual function exists and is generated at build time.
    * @param obj The object to copy.
    * @return An independent clone of that object.
    */
-  public static function copy(obj:Any):Null<Any>
-  {
-    return copyAnonymousFieldsOf(obj);
-  }
+  // public static function copy(obj:Any):Null<Any>
 
   /**
    * Copies the anonymous structure to a new object.
@@ -88,14 +106,13 @@ class ReflectUtil
   /**
    * Delete the field of a given name from an object.
    * Only guaranteed to work on anonymous structures.
+   *
+   * The actual function exists and is generated at build time.
    * @param obj The object to delete the field from.
    * @param name The name of the field to delete.
    * @return Whether the operation was successful.
    */
-  public static function delete(obj:Any, name:String):Bool
-  {
-    return deleteAnonymousField(obj, name);
-  }
+  // public static function delete(obj:Any, name:String):Bool
 
   /**
    * Delete the field of a given name from an anonymous structure.
@@ -112,26 +129,23 @@ class ReflectUtil
   /**
    * Retrive the value of a given field (by name) from an object.
    * Only guaranteed to work on anonymous structures.
+   *
+   * The actual function exists and is generated at build time.
    * @param obj The object to delete the field from.
    * @param name The name of the field to delete.
    * @return Whether the operation was successful.
    */
-  public static function field(obj:Any, name:String):Any
-  {
-    return getAnonymousField(obj, name);
-  }
-
+  // public static function field(obj:Any, name:String):Any
   /**
    * Retrive the value of a given field (by name) from an object.
    * Only guaranteed to work on anonymous structures.
+   *
+   * The actual function exists and is generated at build time.
    * @param obj The object to delete the field from.
    * @param name The name of the field to delete.
    * @return Whether the operation was successful.
    */
-  public static function getField(obj:Any, name:String):Any
-  {
-    return getAnonymousField(obj, name);
-  }
+  // public static function getField(obj:Any, name:String):Any
 
   /**
    * Retrieve the value of the field of the given name from an anonymous structure.
@@ -153,24 +167,21 @@ class ReflectUtil
   /**
    * Get a list of fields available on the given object.
    * Only guaranteed to work on anonymous structures.
+   *
+   * The actual function exists and is generated at build time.
    * @param obj The object to query.
    * @return A list of fields on that object.
    */
-  public static function fields(obj:Any):Array<String>
-  {
-    return getAnonymousFieldsOf(obj);
-  }
-
+  // public static function fields(obj:Any):Array<String>
   /**
    * Get a list of fields available on the given object.
    * Only guaranteed to work on anonymous structures.
+   *
+   * The actual function exists and is generated at build time.
    * @param obj The object to query.
    * @return A list of fields on that object.
    */
-  public static function getFieldsOf(obj:Any):Array<String>
-  {
-    return getAnonymousFieldsOf(obj);
-  }
+  // public static function getFieldsOf(obj:Any):Array<String>
 
   /**
    * Get a list of fields available on the given anonymous structure.
@@ -191,6 +202,7 @@ class ReflectUtil
    * @return The value of the field.
    * @throws error If the field is blacklisted.
    */
+  @:blacklistOverride
   public static function getProperty(obj:Any, name:String):Any
   {
     if (FIELD_NAME_BLACKLIST.contains(name))
@@ -201,18 +213,6 @@ class ReflectUtil
     return Reflect.getProperty(obj, name);
   }
 
-  /**
-   * Determine whether the given object has the given field.
-   * Only guaranteed to work for anonymous structures.
-   * @param obj The object to query.
-   * @param name The field name to query.
-   * @return Whether the field exists.
-   */
-  public static function hasField(obj:Any, name:String):Bool
-  {
-    return hasAnonymousField(obj, name);
-  }
-
   /**
    * Determine whether the given anonymous structure has the given field.
    * @param obj The structure to query.
@@ -231,45 +231,38 @@ class ReflectUtil
 
   /**
    * Determine whether the given input is an enum value.
+   *
+   * The actual function exists and is generated at build time.
    * @param value The input to evaluate.
    * @return Whether `value` is an enum value.
    */
-  public static function isEnumValue(value:Any):Bool
-  {
-    return Reflect.isEnumValue(value);
-  }
-
+  // public static function isEnumValue(value:Any):Bool
   /**
    * Determine whether the given input is a callable function.
+   *
+   * The actual function exists and is generated at build time.
    * @param value The input to evaluate.
    * @return Whether `value` is a function.
    */
-  public static function isFunction(value:Any):Bool
-  {
-    return Reflect.isFunction(value);
-  }
-
+  // public static function isFunction(value:Any):Bool
   /**
    * Determine whether the given input is an object.
+   *
+   * The actual function exists and is generated at build time.
    * @param value The input to evaluate.
    * @return Whether `value` is an object.
    */
-  public static function isObject(value:Any):Bool
-  {
-    return Reflect.isObject(value);
-  }
-
+  // public static function isObject(value:Any):Bool
   /**
    * Set the value of a specific field on an object.
    * Only guaranteed to work for anonymous structures.
+   *
+   * The actual function exists and is generated at build time.
    * @param obj The object to modify.
    * @param name The field to modify.
    * @param value The new value to apply.
    */
-  public static function setField(obj:Any, name:String, value:Any):Void
-  {
-    return setAnonymousField(obj, name, value);
-  }
+  // public static function setField(obj:Any, name:String, value:Any):Void
 
   /**
    * Set the value of a specific field on an anonymous structure.
@@ -285,74 +278,45 @@ class ReflectUtil
   /**
    * Set the value of a specific field on an object.
    * Accounts for property fields with getters and setters.
+   *
+   * The actual function exists and is generated at build time.
    * @param obj The object to modify.
    * @param name The field to modify.
    * @param value The new value to apply.
    */
-  public static function setProperty(obj:Any, name:String, value:Any):Void
-  {
-    return Reflect.setProperty(obj, name, value);
-  }
-
+  // public static function setProperty(obj:Any, name:String, value:Any):Void
   /**
    * This function is not allowed to be used by scripts.
+   *
+   * The actual function exists and is generated at build time.
    * @throws error When called by a script.
    */
-  @SuppressWarnings("checkstyle:FieldDocComment")
-  public static function createEmptyInstance(cls:Class<Any>):Any
-  {
-    throw "Function Type.createEmptyInstance is blacklisted.";
-  }
-
-  /**
-   * This function is not allowed to be used by scripts.
-   * @throws error When called by a script.
-   */
-  @SuppressWarnings("checkstyle:FieldDocComment")
-  public static function createInstance(cls:Class<Any>, args:Array<Any>):Any
-  {
-    throw "Function Type.createInstance is blacklisted.";
-  }
-
+  // public static function createEmptyInstance(cls:Class<Any>):Any
   /**
    * This function is not allowed to be used by scripts.
+   *
+   * The actual function exists and is generated at build time.
    * @throws error When called by a script.
    */
-  @SuppressWarnings("checkstyle:FieldDocComment")
-  public static function resolveClass(name:String):Class<Any>
-  {
-    throw "Function Type.resolveClass is blacklisted.";
-  }
-
+  // public static function createInstance(cls:Class<Any>, args:Array<Any>):Any
   /**
    * This function is not allowed to be used by scripts.
    * @throws error When called by a script.
    */
-  @SuppressWarnings("checkstyle:FieldDocComment")
-  public static function resolveEnum(name:String):Enum<Any>
-  {
-    throw "Function Type.resolveEnum is blacklisted.";
-  }
-
+  // public static function resolveEnum(name:String):Enum<Any>
   /**
    * This function is not allowed to be used by scripts.
    * @throws error When called by a script.
    */
-  @SuppressWarnings("checkstyle:FieldDocComment")
-  public static function typeof(value:Any):ValueType
-  {
-    throw "Function Type.typeof is blacklisted.";
-  }
-
+  // public static function typeof(value:Any):ValueType
   /**
    * Get a list of the static class fields on the given class.
+   *
+   * The actual function exists and is generated at build time.
    * @param cls The class object to query.
    * @return A list of class field names.
    */
-  public static function getClassFields(cls:Class<Any>):Array<String>
-  {
-    return Type.getClassFields(cls);
-  }
+  // public static function getClassFields(cls:Class<Any>):Array<String>
 
   /**
    * Get a list of the static class fields on the class of the given object.
@@ -370,13 +334,12 @@ class ReflectUtil
 
   /**
    * Get a list of all the fields on instances of the given class.
+   *
+   * The actual function exists and is generated at build time.
    * @param cls The class object to query.
    * @return A list of object field names.
    */
-  public static function getInstanceFields(cls:Class<Any>):Array<String>
-  {
-    return Type.getInstanceFields(cls);
-  }
+  // public static function getInstanceFields(cls:Class<Any>):Array<String>
 
   /**
    * Get a list of all the fields on instances of the class of the given object.
@@ -394,13 +357,12 @@ class ReflectUtil
 
   /**
    * Get the string name of the given class.
+   *
+   * The actual function exists and is generated at build time.
    * @param cls The class to query.
    * @return The name of the given class.
    */
-  public static function getClassName(cls:Class<Any>):String
-  {
-    return Type.getClassName(cls);
-  }
+  // public static function getClassName(cls:Class<Any>):String
 
   /**
    * Get the string name of the class of the given object.