// Copyright (c) 2023 Sophie Herold
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
//
// SPDX-License-Identifier: GPL-3.0-or-later
//! The print layout widget that also coordinates the print process
use crate::decoder;
use crate::deps::*;
use crate::util::gettext::*;
use crate::widgets::{LpImage, LpPrintPreview};
use adw::prelude::*;
use adw::subclass::prelude::*;
use glib::Properties;
use gtk::CompositeTemplate;
use once_cell::sync::OnceCell;
use std::cell::{Cell, RefCell};
#[derive(Default, Clone, Copy)]
struct PageAlignment {
horizontal: HAlignment,
vertical: VAlignment,
}
#[derive(Default, Clone, Copy)]
enum HAlignment {
Left,
#[default]
Center,
Right,
}
#[derive(Default, Clone, Copy)]
enum VAlignment {
Top,
#[default]
Middle,
Bottom,
}
impl From<&str> for PageAlignment {
fn from(s: &str) -> Self {
let alignment = match s {
"top" => (HAlignment::Center, VAlignment::Top),
"center" => (HAlignment::Center, VAlignment::Middle),
"bottom" => (HAlignment::Center, VAlignment::Bottom),
"left" => (HAlignment::Left, VAlignment::Middle),
"right" => (HAlignment::Right, VAlignment::Middle),
pos => {
log::error!("Unkown alignment '{pos}'");
(HAlignment::default(), VAlignment::default())
}
};
Self::from(alignment)
}
}
impl From<(HAlignment, VAlignment)> for PageAlignment {
fn from((horizontal, vertical): (HAlignment, VAlignment)) -> Self {
Self {
horizontal,
vertical,
}
}
}
impl std::fmt::Display for PageAlignment {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
let s = match (self.horizontal, self.vertical) {
(HAlignment::Center, VAlignment::Top) => gettext("Top"),
(HAlignment::Center, VAlignment::Middle) => gettext("Center"),
(HAlignment::Center, VAlignment::Bottom) => gettext("Bottom"),
(HAlignment::Left, VAlignment::Middle) => gettext("Left"),
(HAlignment::Right, VAlignment::Middle) => gettext("Right"),
_ => String::from("Unsupported (Error)"),
};
f.write_str(&s)
}
}
mod imp {
use super::*;
#[derive(Debug, Default, CompositeTemplate, Properties)]
#[template(file = "../../data/gtk/print.ui")]
#[properties(wrapper_type = super::LpPrint)]
pub struct LpPrint {
#[template_child]
pub(super) title: TemplateChild,
#[template_child]
pub(super) preview: TemplateChild,
// ListBox entries
#[template_child]
pub(super) alignment: TemplateChild,
#[template_child]
pub(super) margin_horizontal: TemplateChild,
#[template_child]
pub(super) margin_vertical: TemplateChild,
#[template_child]
pub(super) width: TemplateChild,
#[template_child]
pub(super) scale: TemplateChild,
#[template_child]
pub(super) unit: TemplateChild,
#[property(get, set, builder().construct_only())]
pub(super) image: OnceCell,
#[property(get, set, builder().construct_only())]
pub(super) parent_window: OnceCell,
#[property(get, set, builder().construct_only())]
pub(super) print_settings: OnceCell,
#[property(get)]
pub(super) print_operation: gtk::PrintOperation,
#[property(get, set)]
pub(super) orientation: RefCell,
#[property(get, set)]
pub(super) unit_factor: Cell,
}
#[glib::object_subclass]
impl ObjectSubclass for LpPrint {
const NAME: &'static str = "LpPrint";
type Type = super::LpPrint;
type ParentType = adw::Window;
fn class_init(klass: &mut Self::Class) {
Self::bind_template(klass);
Self::Type::bind_template_callbacks(klass);
klass.install_action_async("print.print", None, |print, _, _| async move {
print.print();
});
klass.install_action_async("print.back", None, |print, _, _| async move {
print.back().await;
});
klass.install_property_action("print.orientation", "orientation");
}
fn instance_init(obj: &glib::subclass::InitializingObject) {
obj.init_template();
}
}
impl ObjectImpl for LpPrint {
fn constructed(&self) {
self.parent_constructed();
let obj = self.obj();
obj.set_unit_factor(1.);
obj.set_transient_for(Some(&obj.parent_window()));
obj.set_modal(true);
self.alignment.connect_selected_notify(
glib::clone!(@weak obj => move |_| obj.on_margin_vertical_changed()),
);
self.alignment
.set_expression(Some(gtk::ClosureExpression::new::(
[] as [gtk::Expression; 0],
glib::closure!(
|s: gtk::StringObject| PageAlignment::from(s.string().as_str()).to_string()
),
)));
gtk::ClosureExpression::new::(
[] as [gtk::Expression; 0],
glib::closure!(
|s: gtk::StringObject| PageAlignment::from(s.string().as_str()).to_string()
),
);
self.width
.connect_value_notify(glib::clone!(@weak obj => move |_| obj.on_width_changed()));
self.margin_horizontal.connect_value_notify(
glib::clone!(@weak obj => move |_| obj.on_margin_horizontal_changed()),
);
self.margin_vertical.connect_value_notify(
glib::clone!(@weak obj => move |_| obj.on_margin_vertical_changed()),
);
self.print_operation
.set_print_settings(Some(&obj.print_settings()));
self.print_operation.set_allow_async(true);
self.print_operation.set_n_pages(1);
self.print_operation.set_current_page(0);
if let Some(uri) = obj.image().file().map(|x| x.uri()) {
obj.print_settings()
.set(gtk::PRINT_SETTINGS_OUTPUT_URI, Some(&format!("{uri}.pdf")));
}
self.print_operation.connect_begin_print(move |op, _ctx| {
op.set_n_pages(1);
});
self.print_operation.connect_draw_page(glib::clone!(@weak obj =>
move |operation, _context, _page_nr| {
let imp = obj.imp();
let basename = obj
.image()
.file()
.and_then(|f| f.basename())
.map(|x| x.display().to_string())
.unwrap_or_default();
imp.title.set_title(&gettext_f(
// Translators: {} is a placeholder for the filename
"Print {}",
&[&basename],
));
if let Some(printer) = operation.print_settings().and_then(|x| x.printer()) {
imp.title.set_subtitle(&printer);
}
imp.width.adjustment().set_step_increment(1.);
imp.width.adjustment().set_page_increment(5.);
imp.margin_horizontal.adjustment().set_step_increment(1.);
imp.margin_horizontal.adjustment().set_page_increment(5.);
imp.margin_vertical.adjustment().set_step_increment(1.);
imp.margin_vertical.adjustment().set_page_increment(5.);
obj.set_ranges();
imp.width.set_value(obj.image().image_size().0 as f64);
// TODO: Select center
//obj.center_horizontally();
obj.unit_selected();
imp.print_operation.cancel();
let orientation = match obj.page_setup().orientation() {
gtk::PageOrientation::Portrait => "portrait",
gtk::PageOrientation::Landscape => "landscape",
_ => "other",
};
obj.set_orientation(orientation);
obj.set_visible(true);
}
));
}
fn properties() -> &'static [glib::ParamSpec] {
Self::derived_properties()
}
fn set_property(&self, id: usize, value: &glib::Value, pspec: &glib::ParamSpec) {
self.derived_set_property(id, value, pspec)
}
fn property(&self, id: usize, pspec: &glib::ParamSpec) -> glib::Value {
self.derived_property(id, pspec)
}
}
impl WidgetImpl for LpPrint {}
impl WindowImpl for LpPrint {}
impl AdwWindowImpl for LpPrint {}
}
glib::wrapper! {
pub struct LpPrint(ObjectSubclass)
@extends gtk::Widget, gtk::Window, adw::Window,
@implements gtk::Buildable, gtk::ConstraintTarget;
}
#[gtk::template_callbacks]
impl LpPrint {
pub fn new(
image: LpImage,
parent_window: gtk::Window,
print_settings: Option,
page_setup: Option,
) -> Self {
let print_settings = print_settings.unwrap_or_default();
let obj: Self = glib::Object::builder()
.property("image", image)
.property("print-settings", print_settings)
.property("parent-window", parent_window)
.build();
if let Some(page_setup) = page_setup {
obj.print_operation()
.set_default_page_setup(Some(&page_setup));
}
obj
}
pub fn unit(&self) -> glib::GString {
self.imp()
.unit
.selected_item()
.and_downcast::()
.map(|x| x.string())
.unwrap_or_default()
}
pub fn dpi(&self) -> f64 {
self.print_settings().resolution() as f64
}
pub fn on_width_changed(&self) {
self.imp()
.scale
.set_label(&format!("{:.2}\u{202F}%", self.user_scale() * 100.));
self.draw_preview();
}
fn user_alignment(&self) -> PageAlignment {
let s = self
.imp()
.alignment
.selected_item()
.and_then(|x| x.downcast::().ok())
.map(|x| x.string())
.unwrap_or_default();
PageAlignment::from(s.as_str())
}
/// Returns user selected image width in pixels
pub fn user_width(&self) -> f64 {
f64::max(1., self.imp().width.value() / self.unit_factor())
}
pub fn user_height(&self) -> f64 {
let (_, orig_height) = self.image().image_size();
f64::max(1., orig_height as f64 * self.user_scale())
}
/// Returns scaling of the original image based on selected image size
pub fn user_scale(&self) -> f64 {
let (orig_width, _) = self.image().image_size();
self.user_width() / orig_width as f64
}
pub fn on_margin_horizontal_changed(&self) {
self.draw_preview();
}
/// Returns user selected left margin in pixels
pub fn user_margin_horizontal(&self) -> f64 {
self.imp().margin_horizontal.value() / self.unit_factor()
}
pub fn effective_margin_left(&self) -> f64 {
match self.user_alignment().horizontal {
HAlignment::Left => self.user_margin_horizontal(),
HAlignment::Center => (self.paper_width() - self.user_width()) / 2.,
HAlignment::Right => {
self.paper_width() - self.user_width() - self.user_margin_horizontal()
}
}
}
pub fn paper_width(&self) -> f64 {
self.page_setup().paper_width(gtk::Unit::Inch) * self.dpi()
}
pub fn paper_height(&self) -> f64 {
self.page_setup().paper_height(gtk::Unit::Inch) * self.dpi()
}
pub fn on_margin_vertical_changed(&self) {
self.draw_preview();
}
/// Returns user selected top margin in pixels
pub fn user_margin_vertical(&self) -> f64 {
self.imp().margin_vertical.value() / self.unit_factor()
}
pub fn effective_margin_top(&self) -> f64 {
match self.user_alignment().vertical {
VAlignment::Top => self.user_margin_vertical(),
VAlignment::Middle => (self.paper_height() - self.user_height()) / 2.,
VAlignment::Bottom => {
self.paper_height() - self.user_height() - self.user_margin_vertical()
}
}
}
/// Redraws the preview widget child
fn draw_preview(&self) {
self.imp().preview.queue_resize();
}
/// Sets the allowed ranges for the spin button based on current unit
fn set_ranges(&self) {
let imp = self.imp();
let max_height =
self.page_setup().page_height(gtk::Unit::Inch) * self.dpi() * self.unit_factor();
let max_width =
self.page_setup().page_width(gtk::Unit::Inch) * self.dpi() * self.unit_factor();
imp.width.set_range(self.unit_factor(), max_width);
let min_horizontal_margin = f64::max(
self.page_setup().left_margin(gtk::Unit::Inch),
self.page_setup().right_margin(gtk::Unit::Inch),
) * self.dpi()
* self.unit_factor();
imp.margin_horizontal
.set_range(min_horizontal_margin, min_horizontal_margin + max_width);
let min_vertical_margin =
self.page_setup().top_margin(gtk::Unit::Inch) * self.dpi() * self.unit_factor();
imp.margin_vertical
.set_range(min_vertical_margin, min_vertical_margin + max_height);
}
#[template_callback]
pub fn orientation_changed(&self) {
let orientation = if self.orientation() == "landscape" {
gtk::PageOrientation::Landscape
} else {
gtk::PageOrientation::Portrait
};
self.page_setup().set_orientation(orientation);
self.set_ranges();
self.draw_preview();
}
#[template_callback]
pub fn unit_selected(&self) {
let imp = self.imp();
let (unit_factor, digits) = match self.unit().as_str() {
"cm" => (2.54 / self.dpi(), 2),
"in" => (1. / self.dpi(), 2),
"px" => (1., 0),
unit => {
log::error!("Unknown unit '{unit}'");
(1., 2)
}
};
let update_factor = unit_factor / self.unit_factor();
let width = imp.width.value() * update_factor;
let margin_horizontal = imp.margin_horizontal.value() * update_factor;
let margin_vertical = imp.margin_vertical.value() * update_factor;
self.set_unit_factor(unit_factor);
self.set_ranges();
imp.width.set_digits(digits);
imp.width.set_value(width);
imp.margin_horizontal.set_digits(digits);
imp.margin_horizontal.set_value(margin_horizontal);
imp.margin_vertical.set_digits(digits);
imp.margin_vertical.set_value(margin_vertical);
}
pub fn run(&self) {
self.print_operation()
.run(
gtk::PrintOperationAction::PrintDialog,
self.imp().parent_window.get(),
)
.unwrap();
}
pub fn page_setup(&self) -> gtk::PageSetup {
self.print_operation().default_page_setup()
}
/// Go back to print dialog from image layout
async fn back(&self) {
self.close();
let print = Self::new(
self.image(),
self.parent_window(),
self.print_operation().print_settings(),
Some(self.print_operation().default_page_setup()),
);
print.run();
}
/// Initialize actual print operation
fn print(&self) {
self.close();
let print_operation = gtk::PrintOperation::new();
let print_settings = self.print_operation().print_settings();
if let Some(print_settings) = &print_settings {
if let Some(uri) = self.image().file().map(|x| x.uri()) {
print_settings.set(gtk::PRINT_SETTINGS_OUTPUT_URI, Some(&format!("{uri}.pdf")));
}
}
print_operation.set_print_settings(print_settings.as_ref());
print_operation.set_default_page_setup(Some(&self.print_operation().default_page_setup()));
print_operation.connect_begin_print(move |op, _ctx| {
op.set_n_pages(1);
});
print_operation.connect_draw_page(
glib::clone!(@weak self as obj => move |_operation, context, _page_nr| {
obj.draw_page(context);
}),
);
print_operation
.run(
gtk::PrintOperationAction::Print,
Some(&self.parent_window()),
)
.unwrap();
}
/// Draw PDF for printing
fn draw_page(&self, print_context: >k::PrintContext) {
log::debug!("Drawing image to print");
let image = self.image();
let cairo_dpi = print_context.dpi_x();
let (orig_width, orig_height) = image.image_size();
let texture_scale = self.user_width() / orig_width as f64;
let cairo_scale = cairo_dpi / self.dpi();
let cairo_surface = if image.format().map_or(false, |x| x.is_svg()) {
// Render SVG to exact needed sizes
// TODO: This should be async
decoder::formats::Svg::render_print(
&image.file().unwrap(),
(orig_width as f64 * texture_scale) as i32,
(orig_height as f64 * texture_scale) as i32,
)
.unwrap()
} else {
let texture = image.print_data(texture_scale).unwrap();
let mut downloader = gdk::TextureDownloader::new(&texture);
downloader.set_format(gdk::MemoryFormat::B8g8r8a8Premultiplied);
let (data, stride) = downloader.download_bytes();
let data = data.to_vec();
let width = texture.width();
let height = texture.height();
cairo::ImageSurface::create_for_data(
data,
cairo::Format::ARgb32,
width,
height,
stride as i32,
)
.unwrap()
};
let cairo_context = print_context.cairo_context();
cairo_context.scale(cairo_scale, cairo_scale);
let margin_left = self.effective_margin_left()
- self.page_setup().left_margin(gtk::Unit::Inch) * self.dpi();
let margin_top = self.effective_margin_top()
- self.page_setup().top_margin(gtk::Unit::Inch) * self.dpi();
cairo_context
.set_source_surface(cairo_surface, margin_left, margin_top)
.unwrap();
cairo_context.paint().unwrap();
}
}
trait AdwSpinRowExt {
fn set_range(&self, min: f64, max: f64);
}
use glib::translate::*;
impl AdwSpinRowExt for adw::SpinRow {
fn set_range(&self, min: f64, max: f64) {
unsafe {
adw_spin_row_set_range(self.to_glib_none().0, min, max);
}
}
}
#[link(name = "adwaita-1")]
extern "C" {
pub fn adw_spin_row_set_range(
self_: *mut adw::ffi::AdwSpinRow,
min: std::ffi::c_double,
max: std::ffi::c_double,
);
}