Implemented experiment

2022.9 Release

QuestPDF.Examples/GenerationBenchmark.cs

@@ -0,0 +1,146 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using NUnit.Framework;
+using QuestPDF.Elements;
+using QuestPDF.Fluent;
+using QuestPDF.Helpers;
+
+namespace QuestPDF.Examples
+{
+    public class ProcessRunningTime
+    {
+        public TimeSpan FluentTime { get; set; }
+        public TimeSpan GenerationTime { get; set; }
+        public float Size { get; set; }
+    }
+    
+    public class GenerationBenchmark
+    {
+        public const int TestSize = 4096;
+        
+        [Test]
+        public void BenchmarkAsync()
+        {
+            RunTest(() => Enumerable
+                .Range(0, TestSize)
+                .AsParallel() // difference
+                .Select(GenerateAndCollect)
+                .ToList());
+        }
+        
+        [Test]
+        public void BenchmarkSync()
+        {
+            RunTest(() => Enumerable
+                .Range(0, TestSize)
+                .Select(GenerateAndCollect)
+                .ToList());
+        }
+
+        public void RunTest(Func<IEnumerable<ProcessRunningTime>> handler)
+        {
+            var totalFluentTime = TimeSpan.Zero;
+            var totalGenerationTime = TimeSpan.Zero;
+
+            var stopWatch = new Stopwatch();
+            
+            stopWatch.Start();
+            var results = handler();
+            stopWatch.Stop();
+            
+            foreach (var result in results)
+            {
+                totalFluentTime += result.FluentTime;
+                totalGenerationTime += result.GenerationTime;
+            }
+
+            Console.WriteLine($"Fluent: {totalFluentTime:g}");
+            Console.WriteLine($"Generation: {totalGenerationTime:g}");
+            Console.WriteLine($"Total: {stopWatch.Elapsed:g}");
+        }
+        
+        static ProcessRunningTime GenerateAndCollect(int attemptNumber)
+        {
+            var stopwatch = new Stopwatch();
+            stopwatch.Start();
+            
+            var container = new Container();
+            
+            container
+                .Padding(10)
+                .MinimalBox()
+                .Border(1)
+                .Column(column =>
+                {
+                    column.Item().Text($"Attempts {attemptNumber}");
+                    
+                    const int numberOfRows = 100;
+                    const int numberOfColumns = 10;
+
+                    for (var y = 0; y < numberOfRows; y++)
+                    {
+                        column.Item().Row(row =>
+                        {
+                            for (var x = 0; x < numberOfColumns; x++)
+                            {
+                                row.RelativeItem()
+                                    
+                                    .Background(Colors.Red.Lighten5)
+                                    .Padding(3)
+                                    
+                                    .Background(Colors.Red.Lighten4)
+                                    .Padding(3)
+                                    
+                                    .Background(Colors.Red.Lighten3)
+                                    .Padding(3)
+                                    
+                                    .Background(Colors.Red.Lighten2)
+                                    .Padding(3)
+                                    
+                                    .Background(Colors.Red.Lighten1)
+                                    .Padding(3)
+                                    
+                                    .Background(Colors.Red.Medium)
+                                    .Padding(3)
+                                    
+                                    .Background(Colors.Red.Darken1)
+                                    .Padding(3)
+                                    
+                                    .Background(Colors.Red.Darken2)
+                                    .Padding(3)
+                                    
+                                    .Background(Colors.Red.Darken3)
+                                    .Padding(3)
+                                    
+                                    .Background(Colors.Red.Darken4)
+                                    .Height(3);
+                            }
+                        });
+                    }  
+                });
+
+            var fluentTime = stopwatch.Elapsed;
+            
+            stopwatch.Reset();
+            stopwatch.Start();
+
+            var size = Document
+                .Create(x => x.Page(page => page.Content().Element(container)))
+                .GeneratePdf()
+                .Length;
+
+            var generationTime = stopwatch.Elapsed;
+            
+            return new ProcessRunningTime
+            {
+                FluentTime = fluentTime,
+                GenerationTime = generationTime,
+                Size = size
+            };
+        }
+    }
+}

QuestPDF.Examples/TableBenchmark.cs

@@ -17,7 +17,7 @@ namespace QuestPDF.Examples
                 .PageSize(PageSizes.A4)
                 .ShowResults()
                 .MaxPages(10_000)
-                .EnableCaching(true)
+                //.EnableCaching(true)
                 .EnableDebugging(false)
                 .Render(container =>
                 {

QuestPDF.Previewer/QuestPDF.Previewer.csproj

@@ -4,7 +4,7 @@
         <Authors>MarcinZiabek</Authors>
         <Company>CodeFlint</Company>
         <PackageId>QuestPDF.Previewer</PackageId>
-        <Version>2022.9.0</Version>
+        <Version>2022.9.1</Version>
         <PackAsTool>true</PackAsTool>
         <ToolCommandName>questpdf-previewer</ToolCommandName>
         <PackageDescription>QuestPDF is an open-source, modern and battle-tested library that can help you with generating PDF documents by offering friendly, discoverable and predictable C# fluent API.</PackageDescription>

QuestPDF.ReportSample/DataSource.cs

@@ -15,8 +15,8 @@ namespace QuestPDF.ReportSample
                 HeaderFields = HeaderFields(),
                 
                 LogoData = Helpers.GetImage("Logo.png"),
-                Sections = Enumerable.Range(0, 40).Select(x => GenerateSection()).ToList(),
-                Photos = Enumerable.Range(0, 25).Select(x => GetReportPhotos()).ToList()
+                Sections = Enumerable.Range(0, 2000).Select(x => GenerateSection()).ToList(),
+                Photos = Enumerable.Range(0, 200).Select(x => GetReportPhotos()).ToList()
             };
 
             List<ReportHeaderField> HeaderFields()

QuestPDF.ReportSample/Tests.cs

@@ -24,7 +24,10 @@ namespace QuestPDF.ReportSample
         [Test] 
         public void GenerateAndShowPdf()
         {
-            //ImagePlaceholder.Solid = true;
+            Settings.DocumentLayoutExceptionThreshold = 10_000;
+            Settings.EnableCaching = true;
+            Settings.EnableDebugging = false;
+            ImagePlaceholder.Solid = true;
         
             var path = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, $"test_result.pdf");
             Report.GeneratePdf(path);

QuestPDF.UnitTests/TestEngine/MockCanvas.cs

@@ -20,6 +20,7 @@ namespace QuestPDF.UnitTests.TestEngine
         public void DrawRectangle(Position vector, Size size, string color) => DrawRectFunc(vector, size, color);
         public void DrawText(SKTextBlob skTextBlob, Position position, TextStyle style) => throw new NotImplementedException();
         public void DrawImage(SKImage image, Position position, Size size) => DrawImageFunc(image, position, size);
+        public void DrawPicture(SKPicture picture) => throw new NotImplementedException();
 
         public void DrawHyperlink(string url, Size size) => throw new NotImplementedException();
         public void DrawSectionLink(string sectionName, Size size) => throw new NotImplementedException();

QuestPDF.UnitTests/TestEngine/OperationRecordingCanvas.cs

@@ -18,7 +18,8 @@ namespace QuestPDF.UnitTests.TestEngine
         public void DrawRectangle(Position vector, Size size, string color) => Operations.Add(new CanvasDrawRectangleOperation(vector, size, color));
         public void DrawText(SKTextBlob skTextBlob, Position position, TextStyle style) => throw new NotImplementedException();
         public void DrawImage(SKImage image, Position position, Size size) => Operations.Add(new CanvasDrawImageOperation(position, size));
-        
+        public void DrawPicture(SKPicture picture) => throw new NotImplementedException();
+
         public void DrawHyperlink(string url, Size size) => throw new NotImplementedException();
         public void DrawSectionLink(string sectionName, Size size) => throw new NotImplementedException();
         public void DrawSection(string sectionName) => throw new NotImplementedException();

QuestPDF/Drawing/DocumentGenerator.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using QuestPDF.Drawing.Exceptions;
@@ -67,13 +68,24 @@ namespace QuestPDF.Drawing
             ApplyDefaultTextStyle(content, TextStyle.LibraryDefault);
             
             var debuggingState = Settings.EnableDebugging ? ApplyDebugging(content) : null;
+            debuggingState = null;
             
-            if (Settings.EnableCaching)
-                ApplyCaching(content);
+            //if (Settings.EnableCaching)
+                //ApplyCaching(content);
 
             var pageContext = new PageContext();
+
+            var stopwatch = new Stopwatch();
+            
+            stopwatch.Restart(); 
             RenderPass(pageContext, new FreeCanvas(), content, debuggingState);
+            stopwatch.Stop();
+            Console.WriteLine($"Cold free: {stopwatch.Elapsed}");
+
+            stopwatch.Restart();
             RenderPass(pageContext, canvas, content, debuggingState);
+            stopwatch.Stop();
+            Console.WriteLine($"Canvas: {stopwatch.Elapsed}");
         }
         
         internal static void RenderPass<TCanvas>(PageContext pageContext, TCanvas canvas, Container content, DebuggingState? debuggingState)

QuestPDF/Drawing/FreeCanvas.cs

@@ -51,6 +51,11 @@ namespace QuestPDF.Drawing
             
         }
 
+        public void DrawPicture(SKPicture picture)
+        {
+            
+        }
+
         public void DrawHyperlink(string url, Size size)
         {
            

QuestPDF/Drawing/SkiaCanvasBase.cs

@@ -38,6 +38,11 @@ namespace QuestPDF.Drawing
             Canvas.DrawImage(image, new SKRect(vector.X, vector.Y, size.Width, size.Height));
         }
 
+        public void DrawPicture(SKPicture picture)
+        {
+            Canvas.DrawPicture(picture);
+        }
+
         public void DrawHyperlink(string url, Size size)
         {
             Canvas.DrawUrlAnnotation(new SKRect(0, 0, size.Width, size.Height), url);

QuestPDF/Drawing/SkiaCaptureCanvas.cs

@@ -0,0 +1,39 @@
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.IO;
+using QuestPDF.Helpers;
+using QuestPDF.Infrastructure;
+using SkiaSharp;
+
+namespace QuestPDF.Drawing
+{
+    internal class SkiaCaptureCanvas : SkiaCanvasBase
+    {
+        private SKPictureRecorder? PictureRecorder { get; set; }
+        private Size? CurrentPageSize { get; set; }
+        public SKPicture? CurrentPicture { get; set; }
+        
+        public override void BeginDocument()
+        {
+            
+        }
+
+        public override void BeginPage(Size size)
+        {
+            CurrentPageSize = size;
+            PictureRecorder = new SKPictureRecorder();
+
+            Canvas = PictureRecorder.BeginRecording(new SKRect(0, 0, size.Width, size.Height));
+        }
+
+        public override void EndPage()
+        {
+            CurrentPicture = PictureRecorder?.EndRecording();
+            
+            PictureRecorder?.Dispose();
+            PictureRecorder = null;
+        }
+
+        public override void EndDocument() { }
+    }
+}

QuestPDF/Elements/DrawingCache.cs

@@ -0,0 +1,59 @@
+using System.Collections.Generic;
+using QuestPDF.Drawing;
+using QuestPDF.Helpers;
+using QuestPDF.Infrastructure;
+using SkiaSharp;
+
+namespace QuestPDF.Elements
+{
+    internal class DrawingCache : ContainerElement
+    {
+        private SkiaCaptureCanvas CaptureCanvas { get; } = new();
+        private Dictionary<int, SpacePlan> MeasureCache { get; } = new();
+        private Dictionary<int, SKPicture> DrawCache { get; } = new();
+        
+        ~DrawingCache()
+        {
+            foreach (var picture in DrawCache.Values)
+                picture.Dispose();
+
+            DrawCache.Clear();
+        }
+        
+        internal override void Initialize(IPageContext pageContext, ICanvas canvas)
+        {
+            Child.VisitChildren(x => x.Canvas = CaptureCanvas);
+            base.Initialize(pageContext, canvas);
+        }
+        
+        internal override SpacePlan Measure(Size availableSpace)
+        {
+            var cacheKey = PageContext.CurrentPage;
+
+            if (MeasureCache.TryGetValue(cacheKey, out var result))
+                return result;
+
+            var childSize = Child?.Measure(availableSpace) ?? SpacePlan.FullRender(Size.Zero);
+            MeasureCache.Add(cacheKey, childSize);
+            return childSize;
+        }
+        
+        internal override void Draw(Size availableSpace)
+        {
+            var cacheKey = PageContext.CurrentPage;
+
+            if (DrawCache.TryGetValue(cacheKey, out var result))
+            {
+                Canvas.DrawPicture(result);
+                return;
+            }
+            
+            CaptureCanvas.BeginPage(availableSpace);
+            Child?.Draw(availableSpace);
+            CaptureCanvas.EndPage();
+
+            var picture = CaptureCanvas.CurrentPicture;
+            DrawCache.Add(cacheKey, picture);
+        }
+    }
+}

QuestPDF/Elements/Page.cs

@@ -30,6 +30,7 @@ namespace QuestPDF.Elements
         public void Compose(IContainer container)
         {
             container
+                //.Element(new DrawingCache())
                 .Background(BackgroundColor)
                 .Layers(layers =>
                 {

QuestPDF/Fluent/TextSpanDescriptorExtensions.cs

@@ -15,17 +15,6 @@ namespace QuestPDF.Fluent
             return descriptor;
         }
         
-        public static T Fallback<T>(this T descriptor, TextStyle? value = null) where T : TextSpanDescriptor
-        {
-            descriptor.TextStyle.Fallback = value;
-            return descriptor;
-        }
-        
-        public static T Fallback<T>(this T descriptor, Func<TextStyle, TextStyle> handler) where T : TextSpanDescriptor
-        {
-            return descriptor.Fallback(handler(TextStyle.Default));
-        }
-        
         public static T FontColor<T>(this T descriptor, string value) where T : TextSpanDescriptor
         {
             descriptor.MutateTextStyle(x => x.FontColor(value));

QuestPDF/Infrastructure/ICanvas.cs

@@ -10,6 +10,7 @@ namespace QuestPDF.Infrastructure
         void DrawRectangle(Position vector, Size size, string color);
         void DrawText(SKTextBlob skTextBlob, Position position, TextStyle style);
         void DrawImage(SKImage image, Position position, Size size);
+        void DrawPicture(SKPicture picture);
 
         void DrawHyperlink(string url, Size size);
         void DrawSectionLink(string sectionName, Size size);

QuestPDF/QuestPDF.csproj

@@ -3,7 +3,7 @@
         <Authors>MarcinZiabek</Authors>
         <Company>CodeFlint</Company>
         <PackageId>QuestPDF</PackageId>
-        <Version>2022.9.0-alpha1</Version>
+        <Version>2022.9.0</Version>
         <PackageDescription>QuestPDF is an open-source, modern and battle-tested library that can help you with generating PDF documents by offering friendly, discoverable and predictable C# fluent API.</PackageDescription>
         <PackageReleaseNotes>$([System.IO.File]::ReadAllText("$(MSBuildProjectDirectory)/Resources/ReleaseNotes.txt"))</PackageReleaseNotes>
         <LangVersion>9</LangVersion>

readme.md

@@ -23,7 +23,8 @@ Choosing a project dependency could be difficult. We need to ensure stability an
 
 ⭐ Please give this repository a star. It takes seconds and help thousands of developers! ⭐
 
-<img src="https://user-images.githubusercontent.com/9263853/184642026-27dd7567-a46a-45d4-9594-e6a70a7193e9.png" width="700" />
+<img src="https://user-images.githubusercontent.com/9263853/190931857-8ca52ec8-cc7d-4d12-9467-4442b3342fa1.png" width="700" />
+
 
 ## Please share with the community