Implement IStorageProvider OpenFile/OpenFolder/SaveFile and MessageBox dialogs

Directory.Build.props

@@ -9,6 +9,7 @@
         <Authors>https://github.com/jinek/Consolonia/graphs/contributors</Authors>
         <Description>Text User Interface implementation of Avalonia UI (GUI Framework)</Description>
         <Copyright>Copyright © Evgeny Gorbovoy 2021 - 2022</Copyright>
+        <NoWarn>AVA3001</NoWarn>
     </PropertyGroup>
     <PropertyGroup>
         <AvaloniaVersion>11.0.9</AvaloniaVersion>

src/.editorconfig

@@ -74,6 +74,7 @@ dotnet_diagnostic.ca1043.severity = none # todo: why not to use indexer rather t
 dotnet_diagnostic.ca1814.severity = none # sometimes we need rectangle array
 dotnet_diagnostic.ca1058.severity = none # check why new documentation warns not to derive from ApplicationException. The purpose of last is to distinguish system exceptions like OOM, AssemblyLoadException etc from application logic
 dotnet_diagnostic.ca2000.severity = none # exceptions which are listed in the rule can be applied to any type
+dotnet_diagnostic.CA2007.severity = none # we are assuming task continuation thread is fine by default
 dotnet_diagnostic.ca2213.severity = none # keeping field does not mean necessarity to dispose - it can be dispose somwhere else
 dotnet_diagnostic.ca2248.severity = none # https://github.com/dotnet/roslyn-analyzers/issues/4432
 dotnet_diagnostic.ca1062.severity = none # we are fine with NRE - no need for additional checks

src/Consolonia.Core/Consolonia.Core.csproj

@@ -1,15 +1,22 @@
 <Project Sdk="Microsoft.NET.Sdk">
-    <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Core.Build.props', '$(MSBuildThisFileDirectory)../'))" />
+    <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Core.Build.props', '$(MSBuildThisFileDirectory)../'))" />    
+    <ItemGroup>
+        <AvaloniaXaml Remove="Controls\FileOpen\**" />
+        <Compile Remove="Controls\FileOpen\**" />
+        <EmbeddedResource Remove="Controls\FileOpen\**" />
+        <None Remove="Controls\FileOpen\**" />
+    </ItemGroup>
 
     <ItemGroup>
         <PackageReference Include="Avalonia" Version="$(AvaloniaVersion)" />
         <PackageReference Include="Avalonia.FreeDesktop" Version="$(AvaloniaVersion)" />
         <PackageReference Include="Avalonia.Skia" Version="$(AvaloniaVersion)" />
         <PackageReference Include="Avalonia.Controls.DataGrid" Version="$(AvaloniaVersion)" />
+        <PackageReference Include="CommunityToolkit.Mvvm" Version="8.3.2" />
         <PackageReference Include="SkiaSharp.NativeAssets.Linux.NoDependencies" Version="2.88.8" />
         <PackageReference Include="Unicode.net" Version="2.0.0" />
         <PackageReference Include="Wcwidth" Version="2.0.0" />
     </ItemGroup>
 
+
 </Project>
-

src/Consolonia.Themes.TurboVision/Templates/Controls/Dialog/DialogHelpers.cs → src/Consolonia.Core/Controls/Dialog/DialogHelpers.cs

@@ -11,7 +11,7 @@
 using Avalonia.VisualTree;
 using Consolonia.Core.Helpers;
 
-namespace Consolonia.Themes.TurboVision.Templates.Controls.Dialog
+namespace Consolonia.Core.Controls.Dialog
 {
     public class DialogHost
     {

src/Consolonia.Themes.TurboVision/Templates/Controls/DialogWrap.axaml → src/Consolonia.Core/Controls/Dialog/DialogWrap.axaml

@@ -1,7 +1,7 @@
 <UserControl xmlns="https://github.com/avaloniaui"
              xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
              xmlns:drawing1="clr-namespace:Consolonia.Core.Drawing;assembly=Consolonia.Core"
-             x:Class="Consolonia.Themes.TurboVision.Templates.Controls.DialogWrap">
+             x:Class="Consolonia.Core.Controls.Dialog.DialogWrap">
 
     <Panel>
         <Border Background="{drawing1:ConsoleBrush Mode=Shaded}"

src/Consolonia.Themes.TurboVision/Templates/Controls/DialogWrap.axaml.cs → src/Consolonia.Core/Controls/Dialog/DialogWrap.axaml.cs

@@ -4,12 +4,10 @@
 using Avalonia.Controls;
 using Avalonia.Controls.Presenters;
 using Avalonia.Input;
-using Avalonia.Markup.Xaml;
 using Avalonia.Reactive;
 using Avalonia.VisualTree;
-using Consolonia.Themes.TurboVision.Templates.Controls.Dialog;
 
-namespace Consolonia.Themes.TurboVision.Templates.Controls
+namespace Consolonia.Core.Controls.Dialog
 {
     [SuppressMessage("Usage", "PartialTypeWithSinglePart",
         Justification = "Partial class required for XAML code generation.")]
@@ -52,11 +50,6 @@ private void SetNewSize(Size newSize)
             Height = newSize.Height;
         }
 
-        private void InitializeComponent()
-        {
-            AvaloniaXamlLoader.Load(this);
-        }
-
         public void SetContent(DialogWindow dialogWindow)
         {
             FoundContentPresenter.Content = dialogWindow;

src/Consolonia.Themes.TurboVision/Templates/Controls/Dialog/DialogWindow.cs → src/Consolonia.Core/Controls/DialogWindow.cs

@@ -8,10 +8,11 @@
 using Avalonia.Controls.Primitives;
 using Avalonia.Input;
 using Avalonia.VisualTree;
+using Consolonia.Core.Controls.Dialog;
 
 // ReSharper disable MemberCanBeProtected.Global
 
-namespace Consolonia.Themes.TurboVision.Templates.Controls.Dialog
+namespace Consolonia.Core.Controls
 {
     [TemplatePart("PART_ContentPresenter", typeof(ContentPresenter))]
     public class DialogWindow : UserControl
@@ -24,10 +25,20 @@ public class DialogWindow : UserControl
         public static readonly StyledProperty<bool> IsCloseButtonVisibleProperty =
             AvaloniaProperty.Register<DialogWindow, bool>(nameof(IsCloseButtonVisible), true);
 
+        public static readonly StyledProperty<WindowStartupLocation> WindowStartupLocationProperty =
+            AvaloniaProperty.Register<DialogWindow, WindowStartupLocation>(nameof(WindowStartupLocation));
+
+        public static readonly StyledProperty<bool> CanResizeProperty =
+            AvaloniaProperty.Register<DialogWindow, bool>(nameof(CanResize), true);
+
+        public static readonly StyledProperty<string> IconProperty =
+            AvaloniaProperty.Register<DialogWindow, string>(nameof(Icon));
+
         private Size _contentSize;
         private ContentPresenter _partContentPresenter;
 
-        private TaskCompletionSource _taskCompletionSource;
+        private TaskCompletionSource<object> _taskCompletionSource;
+
 
         static DialogWindow()
         {
@@ -61,6 +72,43 @@ public bool IsCloseButtonVisible
         // ReSharper disable once MemberCanBePrivate.Global
         public bool CancelOnEscape { get; set; } = true;
 
+
+        /// <summary>
+        ///     Enables or disables resizing of the window.
+        /// </summary>
+        public bool CanResize
+        {
+            get => GetValue(CanResizeProperty);
+            set => SetValue(CanResizeProperty, value);
+        }
+
+        /// <summary>
+        ///     Gets or sets the icon of the window.
+        /// </summary>
+        public string Icon
+        {
+            get => GetValue(IconProperty);
+            set => SetValue(IconProperty, value);
+        }
+
+        /// <summary>
+        ///     Gets or sets the startup location of the window.
+        /// </summary>
+        public WindowStartupLocation WindowStartupLocation
+        {
+            get => GetValue(WindowStartupLocationProperty);
+            set => SetValue(WindowStartupLocationProperty, value);
+        }
+
+        /// <summary>
+        ///     Gets or sets the window position in screen coordinates.
+        /// </summary>
+        //public PixelPoint Position
+        //{
+        //    get => PlatformImpl?.Position ?? PixelPoint.Origin;
+        //    set => PlatformImpl?.Move(value);
+        //}
+
         // ReSharper disable once UnusedMember.Global Used by template
         public void CloseClick()
         {
@@ -83,31 +131,60 @@ protected override Size ArrangeOverride(Size finalSize)
             return arrangeOverride;
         }
 
-        private void ShowDialogInternal(Visual parent)
+        protected void ShowDialogInternal(Visual parent)
         {
+            if (WindowStartupLocation == WindowStartupLocation.CenterScreen)
+            {
+                Width = (ushort)(parent.Bounds.Width * .9);
+                Height = (ushort)(parent.Bounds.Height * .9);
+                if (parent is Window window) window.SizeChanged += Window_SizeChanged;
+            }
+
             DialogHost dialogHost = GetDialogHost(parent);
             dialogHost.OpenInternal(this);
         }
 
+        private void Window_SizeChanged(object sender, SizeChangedEventArgs e)
+        {
+            var window = (Window)sender;
+            if (WindowStartupLocation == WindowStartupLocation.CenterScreen)
+            {
+                Width = (ushort)(window.Bounds.Width * .9);
+                Height = (ushort)(window.Bounds.Height * .9);
+            }
+        }
+
         // ReSharper disable once VirtualMemberNeverOverridden.Global overriden in other packages, why resharper suggests this?
-        public virtual void CloseDialog()
+        public virtual void CloseDialog(object result = null)
         {
             DialogHost dialogHost = GetDialogHost(this);
             dialogHost.PopInternal(this);
-            _taskCompletionSource.SetResult();
+            if (Parent is Window window) window.SizeChanged -= Window_SizeChanged;
+            _taskCompletionSource.SetResult(result);
+        }
+
+        public async Task ShowDialogAsync(Control parent)
+        {
+            if (_taskCompletionSource != null)
+                throw new InvalidOperationException("Dialog is already shown.");
+
+            _taskCompletionSource = new TaskCompletionSource<object>();
+            ShowDialogInternal(parent);
+            await _taskCompletionSource.Task;
         }
 
-        public Task ShowDialogAsync(Control parent)
+        public async Task<T> ShowDialogAsync<T>(Control parent)
         {
             if (_taskCompletionSource != null)
-                throw new NotImplementedException();
+                throw new InvalidOperationException("Dialog is already shown.");
 
-            _taskCompletionSource = new TaskCompletionSource();
+            _taskCompletionSource = new TaskCompletionSource<object>();
             ShowDialogInternal(parent);
-            return _taskCompletionSource.Task;
+            object result = await _taskCompletionSource.Task;
+            return (T)result;
         }
 
-        private static DialogHost GetDialogHost(Visual parent)
+        protected static DialogHost GetDialogHost(Visual parent)
         {
             var window = parent.FindAncestorOfType<Window>(true);
             DialogHost dialogHost = window!.GetValue(DialogHost.DialogHostProperty);

src/Consolonia.Core/Controls/FileOpenPicker.axaml

@@ -0,0 +1,69 @@
+<controls:DialogWindow xmlns="https://github.com/avaloniaui"
+                       xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+                       xmlns:storage="clr-namespace:Avalonia.Platform.Storage;assembly=Avalonia.Base"
+                       xmlns:controls="clr-namespace:Consolonia.Core.Controls"
+                       HorizontalAlignment="Center"
+                       VerticalAlignment="Center"
+                       x:DataType="controls:FileOpenPickerViewModel"
+                       x:Class="Consolonia.Core.Controls.FileOpenPicker"
+                       Icon="📰"
+                       CancelOnEscape="True"
+                       Title="{Binding Options.Title}">
+    <Grid RowDefinitions="Auto * Auto Auto">
+        <Grid ColumnDefinitions="Auto *">
+            <TextBlock Text="📁 " />
+            <TextBox Text="{Binding CurrentFolderPath, Mode=TwoWay}"
+                     Grid.Column="1" />
+        </Grid>
+        <ListBox x:Name="ItemsListBox"
+                 Grid.Row="1"
+                 ItemsSource="{Binding Items}"
+                 SelectionMode="{Binding SelectionMode}"
+                 SelectionChanged="ListBox_SelectionChanged"
+                 DoubleTapped="OnDoubleTapped">
+            <ListBox.DataTemplates>
+                <DataTemplate DataType="{x:Type storage:IStorageFolder}">
+                    <Grid ColumnDefinitions="Auto * "
+                          Background="Transparent">
+                        <TextBlock Text="📁"
+                                   Margin="0 0 1 0" />
+                        <TextBlock Grid.Column="1"
+                                   Text="{Binding Name}" />
+                    </Grid>
+                </DataTemplate>
+                <DataTemplate DataType="{x:Type storage:IStorageFile}">
+                    <Grid ColumnDefinitions="Auto *"
+                          Background="Transparent">
+                        <TextBlock Text="📰"
+                                   Margin="0 0 1 0" />
+                        <TextBlock Grid.Column="1"
+                                   Text="{Binding Name}" />
+                    </Grid>
+                </DataTemplate>
+            </ListBox.DataTemplates>
+        </ListBox>
+        <ComboBox Grid.Row="2"
+                  ItemsSource="{Binding Options.FileTypeFilter}"
+                  SelectedIndex="{Binding SelectedFilterIndex}"
+                  HorizontalAlignment="Right">
+            <ComboBox.ItemTemplate>
+                <DataTemplate DataType="{x:Type storage:FilePickerFileType}">
+                    <TextBlock Text="{Binding Name}"
+                               HorizontalAlignment="Stretch" />
+                </DataTemplate>
+            </ComboBox.ItemTemplate>
+        </ComboBox>
+        <StackPanel Grid.Row="3"
+                    Orientation="Horizontal"
+                    HorizontalAlignment="Right"
+                    Margin="1">
+            <Button x:Name="OkButton"
+                    Content="OK"
+                    Click="OnOK"
+                    IsEnabled="{Binding HasSelection}" />
+            <Button x:Name="CancelButton"
+                    Content="Cancel"
+                    Click="OnCancel" />
+        </StackPanel>
+    </Grid>
+</controls:DialogWindow>

src/Consolonia.Core/Controls/FileOpenPicker.axaml.cs

@@ -0,0 +1,83 @@
+using System;
+using Avalonia.Controls;
+using Avalonia.Input;
+using Avalonia.Interactivity;
+using Avalonia.Platform.Storage;
+
+namespace Consolonia.Core.Controls
+{
+    public partial class FileOpenPicker : DialogWindow
+    {
+        public FileOpenPicker()
+            : this(new FilePickerOpenOptions())
+        {
+        }
+
+        public FileOpenPicker(FilePickerOpenOptions options)
+        {
+            WindowStartupLocation = WindowStartupLocation.CenterScreen;
+
+            DataContext = new FileOpenPickerViewModel(options);
+            InitializeComponent();
+            CancelButton.Focus();
+        }
+
+        /// <summary>
+        ///     Gets the view model associated with this picker.
+        /// </summary>
+        /// <exception cref="InvalidOperationException">Thrown when the DataContext is null or not of type FileOpenPickerViewModel.</exception>
+        private FileOpenPickerViewModel ViewModel =>
+            DataContext as FileOpenPickerViewModel
+            ?? throw new InvalidOperationException("DataContext is not properly initialized.");
+
+        private void OnDoubleTapped(object sender, TappedEventArgs e)
+        {
+            var listbox = (ListBox)sender;
+            if (listbox.SelectedItem is IStorageFolder folder)
+            {
+                ViewModel.CurrentFolder = folder;
+                ViewModel.CurrentFolderPath = folder.Path.LocalPath;
+                ViewModel.SelectedFiles.Clear();
+            }
+            else if (listbox.SelectedItem is IStorageFile file)
+            {
+                CloseDialog(new[] { file });
+            }
+        }
+
+        private void OnOK(object sender, RoutedEventArgs e)
+        {
+            CloseDialog(ViewModel.SelectedFiles);
+        }
+
+        private void OnCancel(object sender, RoutedEventArgs e)
+        {
+            CloseDialog();
+        }
+
+        private void ListBox_SelectionChanged(object sender, SelectionChangedEventArgs e)
+        {
+            if (ViewModel.SelectionMode == SelectionMode.Single)
+            {
+                if (e.AddedItems.Count > 0 &&
+                    e.AddedItems[0] is IStorageFile file)
+                {
+                    ViewModel.SelectedFiles.Clear();
+                    ViewModel.SelectedFiles.Add(file);
+                }
+            }
+            else
+            {
+                foreach (object item in e.AddedItems)
+                    if (item is IStorageFile file)
+                        ViewModel.SelectedFiles.Add(file);
+
+                foreach (object item in e.RemovedItems)
+                    if (item is IStorageFile file)
+                        ViewModel.SelectedFiles.Remove(file);
+            }
+
+            ViewModel.HasSelection = ViewModel.SelectedFiles.Count > 0;
+        }
+    }
+}