Merge pull request #543 from AvaloniaUI/simple-grid-devtools

Simple grid devtools

src/Avalonia.Controls/Avalonia.Controls.csproj

@@ -164,7 +164,6 @@
     <Compile Include="ToolTip.cs" />
     <Compile Include="UserControl.cs" />
     <Compile Include="Templates\TemplateExtensions.cs" />
-    <Compile Include="TextWrapping.cs" />
     <Compile Include="Utils\AncestorFinder.cs" />
     <Compile Include="Utils\IEnumerableUtils.cs" />
     <Compile Include="Utils\StringUtils.cs" />

src/Avalonia.Controls/TextBlock.cs

@@ -99,6 +99,7 @@ namespace Avalonia.Controls
         /// </summary>
         static TextBlock()
         {
+            ClipToBoundsProperty.OverrideDefaultValue<TextBlock>(true);
             AffectsRender(ForegroundProperty);
             AffectsRender(FontWeightProperty);
             AffectsRender(FontSizeProperty);
@@ -355,7 +356,8 @@ namespace Avalonia.Controls
                 FontSize,
                 FontStyle,
                 TextAlignment,
-                FontWeight);
+                FontWeight,
+                TextWrapping);
             result.Constraint = constraint;
             return result;
         }

src/Avalonia.Diagnostics/Avalonia.Diagnostics.csproj

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
   <PropertyGroup>
@@ -105,6 +105,7 @@
     <Compile Include="ViewModels\LogicalTreeNode.cs" />
     <Compile Include="ViewModels\TreeNode.cs" />
     <Compile Include="ViewModels\VisualTreeNode.cs" />
+    <Compile Include="Views\SimpleGrid.cs" />
     <Compile Include="Views\TreePage.xaml.cs">
       <DependentUpon>TreePageView.xaml</DependentUpon>
     </Compile>

src/Avalonia.Diagnostics/Views/ControlDetailsView.cs

@@ -6,6 +6,7 @@ using System.Collections.Generic;
 using System.Reactive.Linq;
 using Avalonia.Controls;
 using Avalonia.Diagnostics.ViewModels;
+using Avalonia.Media;
 using Avalonia.Styling;
 using ReactiveUI;
 
@@ -35,14 +36,8 @@ namespace Avalonia.Diagnostics.Views
 
             Content = new ScrollViewer
             {
-                Content = new Grid
+                Content = new SimpleGrid
                 {
-                    ColumnDefinitions = new ColumnDefinitions
-                    {
-                        new ColumnDefinition(GridLength.Auto),
-                        new ColumnDefinition(GridLength.Auto),
-                        new ColumnDefinition(GridLength.Auto),
-                    },
                     Styles = new Styles
                     {
                         new Style(x => x.Is<Control>())
@@ -66,16 +61,19 @@ namespace Avalonia.Diagnostics.Views
             yield return new TextBlock
             {
                 Text = property.Name,
+                TextWrapping = TextWrapping.NoWrap,
                 [!ToolTip.TipProperty] = property.WhenAnyValue(x => x.Diagnostic),
             };
 
             yield return new TextBlock
             {
+                TextWrapping = TextWrapping.NoWrap,
                 [!TextBlock.TextProperty] = property.WhenAnyValue(v => v.Value).Select(v => v?.ToString()),
             };
 
             yield return new TextBlock
             {
+                TextWrapping = TextWrapping.NoWrap,
                 [!TextBlock.TextProperty] = property.WhenAnyValue(x => x.Priority),
             };
         }

src/Avalonia.Diagnostics/Views/GridRepeater.cs

@@ -11,10 +11,10 @@ namespace Avalonia.Diagnostics.Views
     internal static class GridRepeater
     {
         public static readonly AttachedProperty<IEnumerable> ItemsProperty =
-            AvaloniaProperty.RegisterAttached<Grid, IEnumerable>("Items", typeof(GridRepeater));
+            AvaloniaProperty.RegisterAttached<SimpleGrid, IEnumerable>("Items", typeof(GridRepeater));
 
         public static readonly AttachedProperty<Func<object, IEnumerable<Control>>> TemplateProperty =
-            AvaloniaProperty.RegisterAttached<Grid, Func<object, IEnumerable<Control>>>("Template", typeof(GridRepeater));
+            AvaloniaProperty.RegisterAttached<SimpleGrid, Func<object, IEnumerable<Control>>>("Template", typeof(GridRepeater));
 
         static GridRepeater()
         {
@@ -23,7 +23,7 @@ namespace Avalonia.Diagnostics.Views
 
         private static void ItemsChanged(AvaloniaPropertyChangedEventArgs e)
         {
-            var grid = (Grid)e.Sender;
+            var grid = (SimpleGrid)e.Sender;
             var items = (IEnumerable)e.NewValue;
             var template = grid.GetValue(TemplateProperty);
 
@@ -32,36 +32,18 @@ namespace Avalonia.Diagnostics.Views
             if (items != null)
             {
                 int count = 0;
-                int cols = grid.ColumnDefinitions.Count;
+                int cols = 3;
 
                 foreach (var item in items)
                 {
                     foreach (var control in template(item))
                     {
                         grid.Children.Add(control);
-                        Grid.SetColumn(control, count % cols);
+                        SimpleGrid.SetColumn(control, count % cols);
-                        Grid.SetRow(control, count / cols);
+                        SimpleGrid.SetRow(control, count / cols);
                         ++count;
                     }
                 }
-
-                int rows = (int)Math.Ceiling((double)count / cols);
-                int difference = rows - grid.RowDefinitions.Count;
-
-                if (difference > 0)
-                {
-                    for (int i = 0; i < difference; ++i)
-                    {
-                        grid.RowDefinitions.Add(new RowDefinition(GridLength.Auto));
-                    }
-                }
-                else if (difference < 0)
-                {
-                    for (int i = 0; i < difference; ++i)
-                    {
-                        grid.RowDefinitions.RemoveAt(grid.RowDefinitions.Count - 1);
-                    }
-                }
             }
         }
     }

src/Avalonia.Diagnostics/Views/SimpleGrid.cs

@@ -0,0 +1,147 @@
+// Copyright (c) The Avalonia Project. All rights reserved.
+// Licensed under the MIT license. See licence.md file in the project root for full license information.
+
+using System.Collections.Generic;
+using System.Linq;
+using Avalonia.Controls;
+
+namespace Avalonia.Diagnostics.Views
+{
+    /// <summary>
+    /// A simple grid control that lays out columns with a equal width and rows to their desired
+    /// size.
+    /// </summary>
+    /// <remarks>
+    /// This is used in the devtools because our <see cref="Grid"/> performance sucks.
+    /// </remarks>
+    public class SimpleGrid : Panel
+    {
+        private List<double> _columnWidths = new List<double>();
+        private List<double> _rowHeights = new List<double>();
+        private double _totalWidth;
+        private double _totalHeight;
+
+        /// <summary>
+        /// Defines the Column attached property.
+        /// </summary>
+        public static readonly AttachedProperty<int> ColumnProperty =
+            AvaloniaProperty.RegisterAttached<SimpleGrid, Control, int>("Column");
+
+        /// <summary>
+        /// Defines the Row attached property.
+        /// </summary>
+        public static readonly AttachedProperty<int> RowProperty =
+            AvaloniaProperty.RegisterAttached<SimpleGrid, Control, int>("Row");
+        
+        /// <summary>
+        /// Gets the value of the Column attached property for a control.
+        /// </summary>
+        /// <param name="control">The control.</param>
+        /// <returns>The control's column.</returns>
+        public static int GetColumn(IControl control)
+        {
+            return control.GetValue(ColumnProperty);
+        }
+
+        /// <summary>
+        /// Gets the value of the Row attached property for a control.
+        /// </summary>
+        /// <param name="control">The control.</param>
+        /// <returns>The control's row.</returns>
+        public static int GetRow(IControl control)
+        {
+            return control.GetValue(RowProperty);
+        }
+
+        /// <summary>
+        /// Sets the value of the Column attached property for a control.
+        /// </summary>
+        /// <param name="control">The control.</param>
+        /// <param name="value">The column value.</param>
+        public static void SetColumn(IControl control, int value)
+        {
+            control.SetValue(ColumnProperty, value);
+        }
+
+        
+        /// <summary>
+        /// Sets the value of the Row attached property for a control.
+        /// </summary>
+        /// <param name="control">The control.</param>
+        /// <param name="value">The row value.</param>
+        public static void SetRow(IControl control, int value)
+        {
+            control.SetValue(RowProperty, value);
+        }
+
+        protected override Size MeasureOverride(Size availableSize)
+        {
+            _columnWidths.Clear();
+            _rowHeights.Clear();
+            _totalWidth = 0;
+            _totalHeight = 0;
+
+            foreach (var child in Children)
+            {
+                var column = GetColumn(child);
+                var row = GetRow(child);
+
+                child.Measure(availableSize);
+
+                var desired = child.DesiredSize;
+                UpdateCell(_columnWidths, column, desired.Width, ref _totalWidth);
+                UpdateCell(_rowHeights, row, desired.Height, ref _totalHeight);
+            }
+
+            return new Size(_totalWidth, _totalHeight);
+        }
+
+        protected override Size ArrangeOverride(Size finalSize)
+        {
+            var columnWidth = finalSize.Width / _columnWidths.Count;
+
+            foreach (var child in Children)
+            {
+                var column = GetColumn(child);
+                var row = GetRow(child);
+                var rect = new Rect(column * columnWidth, GetRowTop(row), columnWidth, _rowHeights[row]);
+                child.Arrange(rect);
+            }
+
+            return new Size(finalSize.Width, _totalHeight);
+        }
+
+        private double UpdateCell(IList<double> cells, int cell, double value, ref double total)
+        {
+            while (cells.Count < cell + 1)
+            {
+                cells.Add(0);
+            }
+
+            var existing = cells[cell];
+
+            if (value > existing)
+            {
+                cells[cell] = value;
+                total += value - existing;
+                return value;
+            }
+            else
+            {
+                return existing;
+            }
+        }
+
+        private double GetRowTop(int row)
+        {
+            var result = 0.0;
+
+            for (var i = 0; i < row; ++i)
+            {
+                result += _rowHeights[i];
+            }
+
+            return result;
+        }
+    }
+}

src/Avalonia.SceneGraph/Avalonia.SceneGraph.csproj

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
   <PropertyGroup>
@@ -68,6 +68,7 @@
     <Compile Include="Media\BrushMappingMode.cs" />
     <Compile Include="Media\Color.cs" />
     <Compile Include="Media\Colors.cs" />
+    <Compile Include="Media\TextWrapping.cs" />
     <Compile Include="Media\TransformGroup.cs" />
     <Compile Include="Media\DashStyle.cs" />
     <Compile Include="Media\DrawingContext.cs" />

src/Avalonia.SceneGraph/Media/FormattedText.cs

@@ -21,13 +21,15 @@ namespace Avalonia.Media
         /// <param name="fontStyle">The font style.</param>
         /// <param name="textAlignment">The text alignment.</param>
         /// <param name="fontWeight">The font weight.</param>
+        /// <param name="wrapping">The text wrapping mode.</param>
         public FormattedText(
             string text,
             string fontFamilyName,
             double fontSize,
-            FontStyle fontStyle,
+            FontStyle fontStyle = FontStyle.Normal,
-            TextAlignment textAlignment,
+            TextAlignment textAlignment = TextAlignment.Left,
-            FontWeight fontWeight)
+            FontWeight fontWeight = FontWeight.Normal,
+            TextWrapping wrapping = TextWrapping.Wrap)
         {
             Contract.Requires<ArgumentNullException>(text != null);
             Contract.Requires<ArgumentNullException>(fontFamilyName != null);
@@ -39,6 +41,7 @@ namespace Avalonia.Media
             FontStyle = fontStyle;
             FontWeight = fontWeight;
             TextAlignment = textAlignment;
+            Wrapping = wrapping;
 
             var platform = AvaloniaLocator.Current.GetService<IPlatformRenderInterface>();
 
@@ -53,7 +56,8 @@ namespace Avalonia.Media
                 fontSize,
                 fontStyle,
                 textAlignment,
-                fontWeight);
+                fontWeight,
+                wrapping);
         }
 
         /// <summary>
@@ -76,63 +80,42 @@ namespace Avalonia.Media
         /// <summary>
         /// Gets the font family.
         /// </summary>
-        public string FontFamilyName
+        public string FontFamilyName { get; }
-        {
-            get;
-            private set;
-        }
 
         /// <summary>
         /// Gets the font size.
         /// </summary>
-        public double FontSize
+        public double FontSize { get; }
-        {
-            get;
-            private set;
-        }
 
         /// <summary>
         /// Gets the font style.
         /// </summary>
-        public FontStyle FontStyle
+        public FontStyle FontStyle { get; }
-        {
-            get;
-            private set;
-        }
 
         /// <summary>
         /// Gets the font weight.
         /// </summary>
-        public FontWeight FontWeight
+        public FontWeight FontWeight { get; }
-        {
-            get;
-            private set;
-        }
 
         /// <summary>
         /// Gets the text.
         /// </summary>
-        public string Text
+        public string Text { get; }
-        {
-            get;
-            private set;
-        }
 
         /// <summary>
         /// Gets platform-specific platform implementation.
         /// </summary>
-        public IFormattedTextImpl PlatformImpl
+        public IFormattedTextImpl PlatformImpl { get; }
-        {
-            get; }
 
         /// <summary>
         /// Gets the text alignment.
         /// </summary>
-        public TextAlignment TextAlignment
+        public TextAlignment TextAlignment { get; }
-        {
+
-            get;
+        /// <summary>
-            private set;
+        /// Gets the text wrapping.
-        }
+        /// </summary>
+        public TextWrapping Wrapping { get; }
 
         /// <summary>
         /// Disposes of unmanaged resources associated with the formatted text.

src/Avalonia.Controls/TextWrapping.cs → src/Avalonia.SceneGraph/Media/TextWrapping.cs

@@ -1,10 +1,10 @@
 // Copyright (c) The Avalonia Project. All rights reserved.
 // Licensed under the MIT license. See licence.md file in the project root for full license information.
 
-namespace Avalonia.Controls
+namespace Avalonia.Media
 {
     /// <summary>
-    /// Controls the wrapping mode in a <see cref="TextBlock"/>.
+    /// Controls the wrapping mode of text.
     /// </summary>
     public enum TextWrapping
     {

src/Avalonia.SceneGraph/Platform/IPlatformRenderInterface.cs

@@ -20,6 +20,7 @@ namespace Avalonia.Platform
         /// <param name="fontStyle">The font style.</param>
         /// <param name="textAlignment">The text alignment.</param>
         /// <param name="fontWeight">The font weight.</param>
+        /// <param name="wrapping">The text wrapping mode.</param>
         /// <returns>An <see cref="IFormattedTextImpl"/>.</returns>
         IFormattedTextImpl CreateFormattedText(
             string text,
@@ -27,7 +28,8 @@ namespace Avalonia.Platform
             double fontSize,
             FontStyle fontStyle,
             TextAlignment textAlignment,
-            FontWeight fontWeight);
+            FontWeight fontWeight,
+            TextWrapping wrapping);
 
         /// <summary>
         /// Creates a stream geometry implementation.

src/Avalonia.SceneGraph/Rendering/RendererMixin.cs

@@ -62,7 +62,8 @@ namespace Avalonia.Rendering
                         var txt = new FormattedText("Frame #" + s_frameNum + " FPS: " + s_fps, "Arial", 18,
                             FontStyle.Normal,
                             TextAlignment.Left,
-                            FontWeight.Normal))
+                            FontWeight.Normal,
+                            TextWrapping.NoWrap))
                     {
                         ctx.FillRectangle(Brushes.White, new Rect(pt, txt.Measure()));
                         ctx.DrawText(Brushes.Black, pt, txt);

src/Gtk/Avalonia.Cairo/CairoPlatform.cs

@@ -44,7 +44,8 @@ namespace Avalonia.Cairo
             double fontSize,
             FontStyle fontStyle,
             TextAlignment textAlignment,
-            Avalonia.Media.FontWeight fontWeight)
+            Avalonia.Media.FontWeight fontWeight,
+            TextWrapping wrapping)
         {
             return new FormattedTextImpl(s_pangoContext, text, fontFamily, fontSize, fontStyle, textAlignment, fontWeight);
         }

src/Skia/Avalonia.Skia/PlatformRenderInterface.cs

@@ -18,7 +18,7 @@ namespace Avalonia.Skia
         }
 
         public IFormattedTextImpl CreateFormattedText(string text, string fontFamilyName, double fontSize, FontStyle fontStyle,
-            TextAlignment textAlignment, FontWeight fontWeight)
+            TextAlignment textAlignment, FontWeight fontWeight, TextWrapping wrapping)
         {
             return FormattedTextImpl.Create(text, fontFamilyName, fontSize, fontStyle, textAlignment, fontWeight);
         }

src/Windows/Avalonia.Direct2D1/Direct2D1Platform.cs

@@ -49,9 +49,10 @@ namespace Avalonia.Direct2D1
             double fontSize,
             FontStyle fontStyle,
             TextAlignment textAlignment,
-            FontWeight fontWeight)
+            FontWeight fontWeight,
+            TextWrapping wrapping)
         {
-            return new FormattedTextImpl(text, fontFamily, fontSize, fontStyle, textAlignment, fontWeight);
+            return new FormattedTextImpl(text, fontFamily, fontSize, fontStyle, textAlignment, fontWeight, wrapping);
         }
 
         public IRenderTarget CreateRenderer(IPlatformHandle handle)

src/Windows/Avalonia.Direct2D1/Media/FormattedTextImpl.cs

@@ -18,7 +18,8 @@ namespace Avalonia.Direct2D1.Media
             double fontSize,
             FontStyle fontStyle,
             TextAlignment textAlignment,
-            FontWeight fontWeight)
+            FontWeight fontWeight,
+            TextWrapping wrapping)
         {
             var factory = AvaloniaLocator.Current.GetService<DWrite.Factory>();
 
@@ -29,6 +30,9 @@ namespace Avalonia.Direct2D1.Media
                 (DWrite.FontStyle)fontStyle,
                 (float)fontSize))
             {
+                format.WordWrapping = wrapping == TextWrapping.Wrap ? 
+                    DWrite.WordWrapping.Wrap : DWrite.WordWrapping.NoWrap;
+
                 TextLayout = new DWrite.TextLayout(
                     factory,
                     text ?? string.Empty,

tests/Avalonia.RenderTests/Avalonia.Direct2D1.RenderTests.csproj

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
@@ -73,6 +73,7 @@
     <Otherwise />
   </Choose>
   <ItemGroup>
+    <Compile Include="Controls\TextBlockTests.cs" />
     <Compile Include="Media\ImageBrushTests.cs" />
     <Compile Include="Media\VisualBrushTests.cs" />
     <Compile Include="Controls\ImageTests.cs" />

tests/Avalonia.RenderTests/Controls/TextBlockTests.cs

@@ -0,0 +1,47 @@
+// Copyright (c) The Avalonia Project. All rights reserved.
+// Licensed under the MIT license. See licence.md file in the project root for full license information.
+
+using Avalonia.Controls;
+using Avalonia.Layout;
+using Avalonia.Media;
+using Xunit;
+
+#if AVALONIA_CAIRO
+namespace Avalonia.Cairo.RenderTests.Controls
+#elif AVALONIA_SKIA
+namespace Avalonia.Skia.RenderTests
+#else
+namespace Avalonia.Direct2D1.RenderTests.Controls
+#endif
+{
+    public class TextBlockTests : TestBase
+    {
+        public TextBlockTests()
+            : base(@"Controls\TextBlock")
+        {
+        }
+
+        [Fact]
+        public void Wrapping_NoWrap()
+        {
+            Decorator target = new Decorator
+            {
+                Padding = new Thickness(8),
+                Width = 200,
+                Height = 200,
+                Child = new TextBlock
+                {
+                    Background = Brushes.Red,
+                    FontSize = 12,
+                    Foreground = Brushes.Black,
+                    Text = "Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit",
+                    VerticalAlignment = VerticalAlignment.Top,
+                    TextWrapping = TextWrapping.NoWrap,
+                }
+            };
+
+            RenderToFile(target);
+            CompareImages();
+        }
+    }
+}

tests/Avalonia.RenderTests/TestBase.cs

@@ -58,6 +58,11 @@ namespace Avalonia.Direct2D1.RenderTests
 
         protected void RenderToFile(Control target, [CallerMemberName] string testName = "")
         {
+            if (!Directory.Exists(OutputPath))
+            {
+                Directory.CreateDirectory(OutputPath);
+            }
+
             string path = Path.Combine(OutputPath, testName + ".out.png");
 
             using (RenderTargetBitmap bitmap = new RenderTargetBitmap(

tests/Avalonia.UnitTests/TestServices.cs

@@ -143,7 +143,8 @@ namespace Avalonia.UnitTests
                     It.IsAny<double>(),
                     It.IsAny<FontStyle>(),
                     It.IsAny<TextAlignment>(),
-                    It.IsAny<FontWeight>()) == Mock.Of<IFormattedTextImpl>() &&
+                    It.IsAny<FontWeight>(),
+                    It.IsAny<TextWrapping>()) == Mock.Of<IFormattedTextImpl>() &&
                 x.CreateStreamGeometry() == Mock.Of<IStreamGeometryImpl>(
                     y => y.Open() == Mock.Of<IStreamGeometryContextImpl>()));
         }