Merge branch 'main' into feature/image-generation-settings

This commit is contained in:
Marcin Ziąbek
2023-05-20 12:00:18 +02:00
committed by GitHub
9 changed files with 108 additions and 25 deletions
+34 -5
View File
@@ -1,5 +1,6 @@
using System; using System;
using System.IO; using System.IO;
using System.Linq;
using NUnit.Framework; using NUnit.Framework;
using QuestPDF.Drawing.Exceptions; using QuestPDF.Drawing.Exceptions;
using QuestPDF.Examples.Engine; using QuestPDF.Examples.Engine;
@@ -79,11 +80,11 @@ namespace QuestPDF.Examples
.ShowResults() .ShowResults()
.Render(page => .Render(page =>
{ {
page.Padding(10).Column(column => page.Padding(15).Column(column =>
{ {
column.Spacing(10); column.Spacing(15);
column.Item().Image("photo.jpg").WithRasterDpi(16); column.Item().Image("photo.jpg").WithRasterDpi(16).FitUnproportionally();
column.Item().Image("photo.jpg").WithRasterDpi(72); column.Item().Image("photo.jpg").WithRasterDpi(72);
}); });
}); });
@@ -99,9 +100,9 @@ namespace QuestPDF.Examples
.ShowResults() .ShowResults()
.Render(page => .Render(page =>
{ {
page.Padding(10).Column(column => page.Padding(15).Column(column =>
{ {
column.Spacing(10); column.Spacing(15);
column.Item().Image("photo.jpg").WithCompressionQuality(ImageCompressionQuality.VeryLow).WithRasterDpi(72); column.Item().Image("photo.jpg").WithCompressionQuality(ImageCompressionQuality.VeryLow).WithRasterDpi(72);
column.Item().Image("photo.jpg").WithCompressionQuality(ImageCompressionQuality.High).WithRasterDpi(72); column.Item().Image("photo.jpg").WithCompressionQuality(ImageCompressionQuality.High).WithRasterDpi(72);
@@ -109,6 +110,34 @@ namespace QuestPDF.Examples
}); });
} }
[Test]
public void ReusingImage_With()
{
RenderingTest
.Create()
.PageSize(400, 600)
.ProduceImages()
.ShowResults()
.Render(page =>
{
page.Padding(15).Column(column =>
{
column.Spacing(15);
var image = Image.FromFile("checkbox.png");
foreach (var i in Enumerable.Range(0, 5))
{
column.Item().Row(row =>
{
row.AutoItem().Width(24).Image(image);
row.RelativeItem().PaddingLeft(8).AlignMiddle().Text(Placeholders.Label()).FontSize(16);
});
}
});
});
}
[Test] [Test]
public void Exception() public void Exception()
{ {
@@ -38,6 +38,9 @@
<None Update="photo.jpg"> <None Update="photo.jpg">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None> </None>
<None Update="checkbox.png">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
</ItemGroup> </ItemGroup>
</Project> </Project>
Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 KiB

+1 -1
View File
@@ -85,7 +85,7 @@ namespace QuestPDF.UnitTests
{ {
container.Column(column => container.Column(column =>
{ {
var sharedImage = DocumentImage.FromBinaryData(photo).DisposeAfterDocumentGeneration(); var sharedImage = DocumentImage.FromBinaryData(photo);
foreach (var i in Enumerable.Range(0, 10)) foreach (var i in Enumerable.Range(0, 10))
column.Item().Image(sharedImage); column.Item().Image(sharedImage);
+8 -5
View File
@@ -52,7 +52,7 @@ namespace QuestPDF.Drawing
var documentSettings = document.GetSettings(); var documentSettings = document.GetSettings();
documentSettings.ImageRasterDpi = settings.RasterDpi; documentSettings.ImageRasterDpi = settings.RasterDpi;
var canvas = new ImageCanvas(settings); var canvas = new ImageCanvas(settings);
RenderDocument(canvas, document, documentSettings); RenderDocument(canvas, document, documentSettings, useOriginalImages: true);
return canvas.Images; return canvas.Images;
} }
@@ -93,7 +93,7 @@ namespace QuestPDF.Drawing
return canvas.Pictures; return canvas.Pictures;
} }
internal static void RenderDocument<TCanvas>(TCanvas canvas, IDocument document, DocumentSettings settings) internal static void RenderDocument<TCanvas>(TCanvas canvas, IDocument document, DocumentSettings settings, bool useOriginalImages = false)
where TCanvas : ICanvas, IRenderingCanvas where TCanvas : ICanvas, IRenderingCanvas
{ {
var container = new DocumentContainer(); var container = new DocumentContainer();
@@ -102,7 +102,7 @@ namespace QuestPDF.Drawing
ApplyInheritedAndGlobalTexStyle(content, TextStyle.Default); ApplyInheritedAndGlobalTexStyle(content, TextStyle.Default);
ApplyContentDirection(content, settings.ContentDirection); ApplyContentDirection(content, settings.ContentDirection);
ApplyDefaultImageConfiguration(content, settings.ImageRasterDpi, settings.ImageCompressionQuality); ApplyDefaultImageConfiguration(content, settings.ImageRasterDpi, settings.ImageCompressionQuality, useOriginalImages);
var debuggingState = Settings.EnableDebugging ? ApplyDebugging(content) : null; var debuggingState = Settings.EnableDebugging ? ApplyDebugging(content) : null;
@@ -229,7 +229,7 @@ namespace QuestPDF.Drawing
ApplyContentDirection(child, direction); ApplyContentDirection(child, direction);
} }
internal static void ApplyDefaultImageConfiguration(this Element? content, int imageRasterDpi, ImageCompressionQuality imageCompressionQuality) internal static void ApplyDefaultImageConfiguration(this Element? content, int imageRasterDpi, ImageCompressionQuality imageCompressionQuality, bool useOriginalImages)
{ {
content.VisitChildren(x => content.VisitChildren(x =>
{ {
@@ -237,25 +237,28 @@ namespace QuestPDF.Drawing
{ {
image.TargetDpi ??= imageRasterDpi; image.TargetDpi ??= imageRasterDpi;
image.CompressionQuality ??= imageCompressionQuality; image.CompressionQuality ??= imageCompressionQuality;
image.UseOriginalImage |= useOriginalImages;
} }
if (x is QuestPDF.Elements.DynamicImage dynamicImage) if (x is QuestPDF.Elements.DynamicImage dynamicImage)
{ {
dynamicImage.TargetDpi ??= imageRasterDpi; dynamicImage.TargetDpi ??= imageRasterDpi;
dynamicImage.CompressionQuality ??= imageCompressionQuality; dynamicImage.CompressionQuality ??= imageCompressionQuality;
dynamicImage.UseOriginalImage |= useOriginalImages;
} }
if (x is DynamicHost dynamicHost) if (x is DynamicHost dynamicHost)
{ {
dynamicHost.ImageTargetDpi ??= imageRasterDpi; dynamicHost.ImageTargetDpi ??= imageRasterDpi;
dynamicHost.ImageCompressionQuality ??= imageCompressionQuality; dynamicHost.ImageCompressionQuality ??= imageCompressionQuality;
dynamicHost.UseOriginalImage |= useOriginalImages;
} }
if (x is TextBlock textBlock) if (x is TextBlock textBlock)
{ {
foreach (var textBlockElement in textBlock.Items.OfType<TextBlockElement>()) foreach (var textBlockElement in textBlock.Items.OfType<TextBlockElement>())
{ {
textBlockElement.Element.ApplyDefaultImageConfiguration(imageRasterDpi, imageCompressionQuality); textBlockElement.Element.ApplyDefaultImageConfiguration(imageRasterDpi, imageCompressionQuality, useOriginalImages);
} }
} }
}); });
+4 -1
View File
@@ -16,6 +16,7 @@ namespace QuestPDF.Elements
internal int? ImageTargetDpi { get; set; } internal int? ImageTargetDpi { get; set; }
internal ImageCompressionQuality? ImageCompressionQuality { get; set; } internal ImageCompressionQuality? ImageCompressionQuality { get; set; }
internal bool UseOriginalImage { get; set; }
public DynamicHost(DynamicComponentProxy child) public DynamicHost(DynamicComponentProxy child)
{ {
@@ -63,6 +64,7 @@ namespace QuestPDF.Elements
ImageTargetDpi = ImageTargetDpi.Value, ImageTargetDpi = ImageTargetDpi.Value,
ImageCompressionQuality = ImageCompressionQuality.Value, ImageCompressionQuality = ImageCompressionQuality.Value,
UseOriginalImage = UseOriginalImage,
PageNumber = PageContext.CurrentPage, PageNumber = PageContext.CurrentPage,
TotalPages = PageContext.GetLocation(Infrastructure.PageContext.DocumentLocation).PageEnd, TotalPages = PageContext.GetLocation(Infrastructure.PageContext.DocumentLocation).PageEnd,
@@ -88,6 +90,7 @@ namespace QuestPDF.Elements
internal int ImageTargetDpi { get; set; } internal int ImageTargetDpi { get; set; }
internal ImageCompressionQuality ImageCompressionQuality { get; set; } internal ImageCompressionQuality ImageCompressionQuality { get; set; }
internal bool UseOriginalImage { get; set; }
public int PageNumber { get; internal set; } public int PageNumber { get; internal set; }
public int TotalPages { get; internal set; } public int TotalPages { get; internal set; }
@@ -100,7 +103,7 @@ namespace QuestPDF.Elements
container.ApplyInheritedAndGlobalTexStyle(TextStyle); container.ApplyInheritedAndGlobalTexStyle(TextStyle);
container.ApplyContentDirection(ContentDirection); container.ApplyContentDirection(ContentDirection);
container.ApplyDefaultImageConfiguration(ImageTargetDpi, ImageCompressionQuality); container.ApplyDefaultImageConfiguration(ImageTargetDpi, ImageCompressionQuality, UseOriginalImage);
container.InjectDependencies(PageContext, Canvas); container.InjectDependencies(PageContext, Canvas);
container.VisitChildren(x => (x as IStateResettable)?.ResetState()); container.VisitChildren(x => (x as IStateResettable)?.ResetState());
+8
View File
@@ -13,6 +13,7 @@ namespace QuestPDF.Elements
{ {
internal int? TargetDpi { get; set; } internal int? TargetDpi { get; set; }
internal ImageCompressionQuality? CompressionQuality { get; set; } internal ImageCompressionQuality? CompressionQuality { get; set; }
internal bool UseOriginalImage { get; set; }
public GenerateDynamicImageDelegate? Source { get; set; } public GenerateDynamicImageDelegate? Source { get; set; }
internal override SpacePlan Measure(Size availableSpace) internal override SpacePlan Measure(Size availableSpace)
@@ -31,6 +32,13 @@ namespace QuestPDF.Elements
return; return;
using var originalImage = SKImage.FromEncodedData(imageData); using var originalImage = SKImage.FromEncodedData(imageData);
if (UseOriginalImage)
{
Canvas.DrawImage(originalImage, Position.Zero, availableSpace);
return;
}
using var compressedImage = originalImage.CompressImage(CompressionQuality.Value); using var compressedImage = originalImage.CompressImage(CompressionQuality.Value);
var targetImage = Helpers.Helpers.GetImageWithSmallerSize(originalImage, compressedImage); var targetImage = Helpers.Helpers.GetImageWithSmallerSize(originalImage, compressedImage);
+3 -3
View File
@@ -109,19 +109,19 @@ namespace QuestPDF.Fluent
{ {
public static ImageDescriptor Image(this IContainer parent, byte[] imageData) public static ImageDescriptor Image(this IContainer parent, byte[] imageData)
{ {
var image = Infrastructure.Image.FromBinaryData(imageData).DisposeAfterDocumentGeneration(); var image = Infrastructure.Image.FromBinaryData(imageData);
return parent.Image(image); return parent.Image(image);
} }
public static ImageDescriptor Image(this IContainer parent, string filePath) public static ImageDescriptor Image(this IContainer parent, string filePath)
{ {
var image = Infrastructure.Image.FromFile(filePath).DisposeAfterDocumentGeneration(); var image = Infrastructure.Image.FromFile(filePath);
return parent.Image(image); return parent.Image(image);
} }
public static ImageDescriptor Image(this IContainer parent, Stream fileStream) public static ImageDescriptor Image(this IContainer parent, Stream fileStream)
{ {
var image = Infrastructure.Image.FromStream(fileStream).DisposeAfterDocumentGeneration(); var image = Infrastructure.Image.FromStream(fileStream);
return parent.Image(image); return parent.Image(image);
} }
+47 -10
View File
@@ -13,28 +13,29 @@ namespace QuestPDF.Infrastructure
internal ImageCompressionQuality CompressionQuality { get; set; } internal ImageCompressionQuality CompressionQuality { get; set; }
} }
public class Image : IDisposable public class Image
{ {
internal SKImage SkImage { get; } internal SKImage SkImage { get; }
internal ImageSize Size { get; } internal ImageSize Size { get; }
internal bool IsDocumentScoped { get; set; } internal bool IsDocumentScoped { get; }
internal LinkedList<(GetImageVersionRequest request, SKImage image)> ScaledImageCache { get; } = new(); internal LinkedList<(GetImageVersionRequest request, SKImage image)> ScaledImageCache { get; } = new();
private Image(SKImage image) internal Image(SKImage image, bool isDocumentScoped)
{ {
SkImage = image; SkImage = image;
IsDocumentScoped = isDocumentScoped;
Size = new ImageSize(image.Width, image.Height); Size = new ImageSize(image.Width, image.Height);
} }
public void Dispose() internal void Dispose()
{ {
SkImage.Dispose(); SkImage.Dispose();
foreach (var cacheKey in ScaledImageCache) foreach (var cacheKey in ScaledImageCache)
cacheKey.image.Dispose(); cacheKey.image.Dispose();
} }
#region Scaling Image #region Scaling Image
internal SKImage GetVersionOfSize(GetImageVersionRequest request) internal SKImage GetVersionOfSize(GetImageVersionRequest request)
@@ -79,15 +80,51 @@ namespace QuestPDF.Infrastructure
if (image == null) if (image == null)
throw new DocumentComposeException("Cannot load or decode provided image."); throw new DocumentComposeException("Cannot load or decode provided image.");
return new Image(image); return new Image(image, true);
} }
#endregion #endregion
}
internal Image DisposeAfterDocumentGeneration() public class SharedImage : Image, IDisposable
{
internal SharedImage(SKImage image) : base(image, false)
{ {
IsDocumentScoped = true;
return this;
} }
public void Dispose()
{
base.Dispose();
}
#region public constructors
public static new SharedImage FromBinaryData(byte[] imageData)
{
return CreateImage(SKImage.FromEncodedData(imageData));
}
public static new SharedImage FromFile(string filePath)
{
return CreateImage(SKImage.FromEncodedData(filePath));
}
public static new SharedImage FromStream(Stream fileStream)
{
return CreateImage(SKImage.FromEncodedData(fileStream));
}
private static SharedImage CreateImage(SKImage? image)
{
if (image == null)
throw new DocumentComposeException("Cannot load or decode provided image.");
var result = new SharedImage(image);
return result;
}
#endregion
} }
} }