using System;
using System.Collections.Generic;
using System.Threading;
using Avalonia.Controls;
using Avalonia.Input;
using Avalonia.Input.Platform;
using Avalonia.Input.Raw;
using Avalonia.Media.Imaging;
using Avalonia.Platform;
using Avalonia.Threading;
namespace Avalonia.Headless;
///
/// Set of extension methods to simplify usage of Avalonia.Headless platform.
///
public static class HeadlessWindowExtensions
{
///
/// Triggers a renderer timer tick and captures last rendered frame.
///
/// Bitmap with last rendered frame. Null, if nothing was rendered.
public static WriteableBitmap? CaptureRenderedFrame(this TopLevel topLevel)
{
WriteableBitmap? bitmap = null;
topLevel.RunJobsOnImpl(w => bitmap = w.GetLastRenderedFrame());
return bitmap;
}
///
/// Reads last rendered frame.
/// Note, in order to trigger rendering timer, call method.
///
/// Bitmap with last rendered frame. Null, if nothing was rendered.
public static WriteableBitmap? GetLastRenderedFrame(this TopLevel topLevel)
{
if (AvaloniaLocator.Current.GetService() is HeadlessPlatformRenderInterface)
{
throw new NotSupportedException(
"To capture a rendered frame, make sure that headless application was initialized with '.UseSkia()' and disabled 'UseHeadlessDrawing' in the 'AvaloniaHeadlessPlatformOptions'.");
}
return GetImpl(topLevel).GetLastRenderedFrame();
}
///
/// Simulates keyboard press on the headless window/toplevel.
///
public static void KeyPress(this TopLevel topLevel, Key key, RawInputModifiers modifiers, PhysicalKey physicalKey,
string? keySymbol) =>
RunJobsOnImpl(topLevel, w => w.KeyPress(key, modifiers, physicalKey, keySymbol));
///
/// Simulates keyboard press on the headless window/toplevel, as if typed on a QWERTY keyboard.
///
public static void KeyPressQwerty(this TopLevel topLevel, PhysicalKey physicalKey, RawInputModifiers modifiers) =>
RunJobsOnImpl(topLevel, w => w.KeyPress(physicalKey.ToQwertyKey(), modifiers, physicalKey, physicalKey.ToQwertyKeySymbol()));
///
/// Simulates keyboard release on the headless window/toplevel.
///
public static void KeyRelease(this TopLevel topLevel, Key key, RawInputModifiers modifiers, PhysicalKey physicalKey,
string? keySymbol) =>
RunJobsOnImpl(topLevel, w => w.KeyRelease(key, modifiers, physicalKey, keySymbol));
///
/// Simulates keyboard release on the headless window/toplevel, as if typed on a QWERTY keyboard.
///
public static void KeyReleaseQwerty(this TopLevel topLevel, PhysicalKey physicalKey, RawInputModifiers modifiers) =>
RunJobsOnImpl(topLevel, w => w.KeyRelease(physicalKey.ToQwertyKey(), modifiers, physicalKey, physicalKey.ToQwertyKeySymbol()));
///
/// Simulates a text input event on the headless window/toplevel.
///
///
/// This event is independent of KeyPress and KeyRelease. If you need to simulate text input to a TextBox or a similar control, please use KeyTextInput.
///
public static void KeyTextInput(this TopLevel topLevel, string text) =>
RunJobsOnImpl(topLevel, w => w.TextInput(text));
///
/// Simulates a mouse down on the headless window/toplevel.
///
///
/// In the headless platform, there is a single mouse pointer. There are no helper methods for touch or pen input.
///
///
/// In the headless platform, there is a single mouse pointer. For touch input use the TouchBegin method.
///
public static void MouseDown(this TopLevel topLevel, Point point, MouseButton button,
RawInputModifiers modifiers = RawInputModifiers.None) =>
RunJobsOnImpl(topLevel, w => w.MouseDown(point, button, modifiers));
///
/// Simulates a mouse move on the headless window/toplevel.
///
public static void MouseMove(this TopLevel topLevel, Point point,
RawInputModifiers modifiers = RawInputModifiers.None) =>
RunJobsOnImpl(topLevel, w => w.MouseMove(point, modifiers));
///
/// Simulates a mouse up on the headless window/toplevel.
///
public static void MouseUp(this TopLevel topLevel, Point point, MouseButton button,
RawInputModifiers modifiers = RawInputModifiers.None) =>
RunJobsOnImpl(topLevel, w => w.MouseUp(point, button, modifiers));
///
/// Simulates a mouse wheel on the headless window/toplevel.
///
public static void MouseWheel(this TopLevel topLevel, Point point, Vector delta,
RawInputModifiers modifiers = RawInputModifiers.None) =>
RunJobsOnImpl(topLevel, w => w.MouseWheel(point, delta, modifiers));
///
/// Simulates a touch contact being pressed on the headless window/toplevel.
///
///
/// A touch pointer to pass to and .
/// Disposing the pointer cancels the contact if it is still pressed.
///
///
/// To simulate multi-touch, keep several returned touch pointers pressed at the same time.
///
public static IHeadlessTouchPointer TouchBegin(this TopLevel topLevel, Point point,
RawInputModifiers modifiers = RawInputModifiers.None)
{
var touchPointId = Interlocked.Increment(ref s_nextTouchPointId);
RunJobsOnImpl(topLevel, w => w.Touch(point, touchPointId, RawPointerEventType.TouchBegin, modifiers));
return new HeadlessTouchPointer(topLevel, touchPointId, point);
}
///
/// Simulates a touch contact being moved on the headless window/toplevel.
///
/// The target headless top level. Must be the one the touch pointer was created on.
/// The touch pointer returned from .
/// The new contact position.
/// The optional key modifiers.
public static void TouchMove(this TopLevel topLevel, IHeadlessTouchPointer touchPointer, Point point,
RawInputModifiers modifiers = RawInputModifiers.None) =>
GetTouchPointer(topLevel, touchPointer).Move(point, modifiers);
///
/// Simulates a touch contact being released on the headless window/toplevel.
///
/// The target headless top level. Must be the one the touch pointer was created on.
/// The touch pointer returned from .
/// The position at which the contact is released.
/// The optional key modifiers.
public static void TouchEnd(this TopLevel topLevel, IHeadlessTouchPointer touchPointer, Point point,
RawInputModifiers modifiers = RawInputModifiers.None) =>
GetTouchPointer(topLevel, touchPointer).End(point, modifiers);
///
/// Simulates a drag and drop target event on the headless window/toplevel. This event simulates a user moving files from another app to the current app.
///
public static void DragDrop(this TopLevel topLevel, Point point, RawDragEventType type, IDataTransfer data,
DragDropEffects effects, RawInputModifiers modifiers = RawInputModifiers.None) =>
RunJobsOnImpl(topLevel, w => w.DragDrop(point, type, data, effects, modifiers));
///
/// Changes the render scaling (DPI) of the headless window/toplevel.
/// This simulates a DPI change, triggering scaling changed notifications and a layout pass.
///
/// The target headless top level.
/// The new render scaling factor. Must be greater than zero.
public static void SetRenderScaling(this TopLevel topLevel, double scaling) =>
RunJobsOnImpl(topLevel, w => w.SetRenderScaling(scaling));
private static void RunJobsOnImpl(this TopLevel topLevel, Action action)
{
RunJobsAndRender();
action(GetImpl(topLevel));
RunJobsAndRender();
static void RunJobsAndRender()
{
var dispatcher = Dispatcher.UIThread;
// Run jobs and render frames until everything is stable.
// We use a simple approach: run jobs, render, and repeat until
// there are no more pending jobs. The render timer tick can schedule
// new jobs, so we loop until stable.
for (var i = 0; i < 10; i++)
{
dispatcher.RunJobs();
AvaloniaHeadlessPlatform.ForceRenderTimerTick();
if (!dispatcher.HasJobsWithPriority(DispatcherPriority.MinimumActiveValue))
return;
}
// Final attempt: run remaining jobs without rendering
dispatcher.RunJobs();
}
}
private static IHeadlessWindow GetImpl(this TopLevel topLevel)
{
return topLevel.PlatformImpl switch
{
null => throw new ObjectDisposedException(topLevel.GetType().Name),
IHeadlessWindow headless => headless,
_ => throw new InvalidOperationException("TopLevel must be a headless window.")
};
}
private static long s_nextTouchPointId;
private static HeadlessTouchPointer GetTouchPointer(TopLevel topLevel, IHeadlessTouchPointer touchPointer)
{
if (touchPointer is not HeadlessTouchPointer headlessTouchPointer)
throw new ArgumentException("The touch pointer was not created by TouchBegin.", nameof(touchPointer));
if (headlessTouchPointer.TopLevel != topLevel)
throw new ArgumentException("The touch pointer belongs to a different toplevel.", nameof(touchPointer));
return headlessTouchPointer;
}
private sealed class HeadlessTouchPointer : IHeadlessTouchPointer
{
private readonly long _touchPointId;
private Point _position;
private bool _pressed = true;
public HeadlessTouchPointer(TopLevel topLevel, long touchPointId, Point position)
{
TopLevel = topLevel;
_touchPointId = touchPointId;
_position = position;
}
public TopLevel TopLevel { get; }
public void Move(Point point, RawInputModifiers modifiers)
{
ThrowIfReleased();
RunJobsOnImpl(TopLevel, w => w.Touch(point, _touchPointId, RawPointerEventType.TouchUpdate, modifiers));
_position = point;
}
public void End(Point point, RawInputModifiers modifiers)
{
ThrowIfReleased();
_pressed = false;
RunJobsOnImpl(TopLevel, w => w.Touch(point, _touchPointId, RawPointerEventType.TouchEnd, modifiers));
}
public void Dispose()
{
if (!_pressed)
return;
_pressed = false;
// The toplevel might have been closed already, cancelling all of its touch pointers.
if (TopLevel.PlatformImpl is IHeadlessWindow)
RunJobsOnImpl(TopLevel, w => w.Touch(_position, _touchPointId, RawPointerEventType.TouchCancel, RawInputModifiers.None));
}
private void ThrowIfReleased()
{
if (!_pressed)
throw new InvalidOperationException("The touch pointer has already been released.");
}
}
}