API validator fixes

Author: Dmytro Ivanov

Assets/Tests/InputSystem/APIVerificationTests.cs

@@ -424,6 +424,14 @@ public class SwitchProControllerHID : UnityEngine.InputSystem.Gamepad
     [Property("Exclusions", @"1.0.0
         public class DualShock4GamepadHID : UnityEngine.InputSystem.DualShock.DualShockGamepad
     ")]
+    // IMECompositionEvent added unsafe attribute
+    [Property("Exclusions", @"1.0.0
+        public struct IMECompositionEvent : UnityEngine.InputSystem.LowLevel.IInputEventTypeInfo
+    ")]
+    // IMECompositionEvent.compositionString changed from field to property due to hard-to-avoid changes to IMECompositionString struct
+    [Property("Exclusions", @"1.0.0
+        public UnityEngine.InputSystem.LowLevel.IMECompositionString compositionString;
+    ")]
     public void API_MinorVersionsHaveNoBreakingChanges()
     {
         var currentVersion = CoreTests.PackageJson.ReadVersion();

Packages/com.unity.inputsystem/Documentation~/Events.md

@@ -70,7 +70,7 @@ There are three types of Device events:
 There are two types of text events:
 
 * [`TextEvent`](../api/UnityEngine.InputSystem.LowLevel.TextEvent.html) (`'TEXT'`)
-* [`IMECompositionEvent`](../api/UnityEngine.InputSystem.LowLevel.IMECompositionEvent.html) (`'IMES'`)
+* [`IMECompositionEventVariableSize`](../api/UnityEngine.InputSystem.LowLevel.IMECompositionEventVariableSize.html) (`'IMEC'`)
 
 ## Working with events
 

Packages/com.unity.inputsystem/Documentation~/filter.yml

@@ -1,4 +1,8 @@
 apiRules:
+  - include:
+      # IMECompositionEvent is marked as obsolete
+      uid: UnityEngine.InputSystem.LowLevel.IMECompositionEvent
+      type: Type
   - exclude:
       # inherited Object methods
       uidRegex: ^System\.Object\..*$

Packages/com.unity.inputsystem/InputSystem/Events/IMECompositionEvent.cs

@@ -6,14 +6,19 @@
 using Unity.Collections.LowLevel.Unsafe;
 using UnityEngine.InputSystem.Utilities;
 
+//// TODO for v2 remove and replace with just string.
+
 namespace UnityEngine.InputSystem.LowLevel
 {
-    [Obsolete("IMECompositionEvent is obsolete, please use IMECompositionEventVariableSize")]
+    /// <summary>
+    /// Deprecated variant of IME composition event. Please use <see cref="IMECompositionEventVariableSize"/> for replacement.
+    /// </summary>
+    [Obsolete("Use IMECompositionEventVariableSize instead.")]
     [StructLayout(LayoutKind.Explicit, Size = InputEvent.kBaseEventSize + sizeof(int) + (sizeof(char) * kIMECharBufferSize))]
     public unsafe struct IMECompositionEvent : IInputEventTypeInfo
     {
         // These needs to match the native ImeCompositionStringInputEventData settings
-        internal const int kIMECharBufferSize = 64;
+        private const int kIMECharBufferSize = 64;
         public const int Type = 0x494D4553;
 
         [FieldOffset(0)]
@@ -76,7 +81,7 @@ public struct IMECompositionEventVariableSize : IInputEventTypeInfo
         /// Returns composition string for the given event.
         /// </summary>
         /// <param name="ev">Pointer to the event.</param>
-        /// <returns></returns>
+        /// <returns>Composition string.</returns>
         public static unsafe IMECompositionString GetIMECompositionString(IMECompositionEventVariableSize* ev)
         {
             return new IMECompositionString(GetCharsPtr(ev), ev->length);
@@ -85,9 +90,9 @@ public static unsafe IMECompositionString GetIMECompositionString(IMEComposition
         /// <summary>
         /// Queues up an IME Composition Event. IME Event sizes are variable, and this simplifies the process of aligning up the Input Event information and actual IME composition string.
         /// </summary>
-        /// <param name="deviceId">ID of the device (see <see cref="InputDevice.deviceId") to which the composition event should be sent to. Should be an <see cref="ITextInputReceiver"/> device. Will trigger <see cref="ITextInputReceiver.OnIMECompositionChanged"/> call when processed.</param>
+        /// <param name="deviceId">ID of the device (see <see cref="InputDevice.deviceId"/>) to which the composition event should be sent to. Should be an <see cref="ITextInputReceiver"/> device. Will trigger <see cref="ITextInputReceiver.OnIMECompositionChanged"/> call when processed.</param>
         /// <param name="str">The IME characters to be sent. This can be any length, or left blank to represent a resetting of the IME dialog.</param>
-        /// <param name="time">The time in seconds, the event was generated at.  This uses the same timeline as <see cref="Time.realtimeSinceStartup"/></param>
+        /// <param name="time">The time in seconds, the event was generated at. This uses the same timeline as <see cref="Time.realtimeSinceStartup"/></param>
         public static unsafe void QueueEvent(int deviceId, string str, double time)
         {
             var sizeInBytes = (InputEvent.kBaseEventSize + sizeof(int)) + sizeof(char) * str.Length;
@@ -108,7 +113,6 @@ public static unsafe void QueueEvent(int deviceId, string str, double time)
         }
     }
 
-    //// TODO for v2 remove and replace with just string.
     /// <summary>
     /// A struct representing an string of characters generated by an IME for text input.
     /// </summary>