// Copyright (c) 2024-2025 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
//! Shows an resizable cropping selection
use std::cell::OnceCell;
use std::sync::Arc;
use adw::prelude::*;
use adw::subclass::prelude::*;
use adw::{glib, gtk};
use glycin::{Operation, Operations};
use crate::deps::*;
use crate::editing::preview::EditingError;
use crate::util::ErrorType;
use crate::util::gettext::*;
use crate::util::root::ParentWindow;
use crate::widgets::LpImage;
use crate::widgets::edit::LpEditCropSelection;
/// Aspect ratio modes that can be selected
#[derive(Debug, Clone, Copy, Default, glib::Enum, glib::Variant)]
#[enum_type(name = "LpAspectRatio")]
pub enum LpAspectRatio {
#[default]
Free,
Original,
/// 1.0
Square,
/// 1.25
R5to4,
/// 1.33
R4to3,
/// 1.5
R3to2,
/// 1.77
R16to9,
}
#[derive(Debug, Clone, Copy, Default, glib::Enum, glib::Variant)]
#[enum_type(name = "LpOrientation")]
pub enum LpOrientation {
#[default]
Landscape,
Portrait,
}
mod imp {
use super::*;
#[derive(Debug, Default, gtk::CompositeTemplate, glib::Properties)]
#[properties(wrapper_type = super::LpEditCrop)]
#[template(file = "crop.ui")]
pub struct LpEditCrop {
#[template_child]
pub(super) image: TemplateChild,
#[template_child]
pub(super) selection: TemplateChild,
#[template_child]
aspect_ratio_buttons: TemplateChild,
#[property(get, construct_only)]
original_image: OnceCell,
#[property(get, set)]
child: OnceCell,
}
#[glib::object_subclass]
impl ObjectSubclass for LpEditCrop {
const NAME: &'static str = "LpEditCrop";
type Type = super::LpEditCrop;
type ParentType = adw::Bin;
fn class_init(klass: &mut Self::Class) {
Self::bind_template(klass);
klass.install_action("edit-crop.mirror-horizontally", None, |obj, _, _| {
obj.imp().apply_mirror_horizontally();
});
klass.install_action("edit-crop.mirror-vertically", None, |obj, _, _| {
obj.imp().apply_mirror_vertically()
});
klass.install_action("edit-crop.rotate-cw", None, |obj, _, _| {
obj.imp().apply_rotate_cw()
});
klass.install_action("edit-crop.rotate-ccw", None, |obj, _, _| {
obj.imp().apply_rotate_ccw()
});
klass.install_action("edit-crop.reset", None, |obj, _, _| {
obj.handle_error(obj.imp().apply_reset())
});
klass.install_action("edit-crop.apply-crop", None, |obj, _, _| {
obj.imp().apply_crop()
});
klass.add_shortcut(
>k::Shortcut::builder()
.action(>k::NamedAction::new("edit-crop.mirror-horizontally"))
.trigger(>k::KeyvalTrigger::new(
gdk::Key::H,
gdk::ModifierType::NO_MODIFIER_MASK,
))
.build(),
);
klass.add_shortcut(
>k::Shortcut::builder()
.action(>k::NamedAction::new("edit-crop.mirror-vertically"))
.trigger(>k::KeyvalTrigger::new(
gdk::Key::V,
gdk::ModifierType::NO_MODIFIER_MASK,
))
.build(),
);
klass.add_shortcut(
>k::Shortcut::builder()
.action(>k::NamedAction::new("edit-crop.rotate-cw"))
.trigger(>k::KeyvalTrigger::new(
gdk::Key::R,
gdk::ModifierType::CONTROL_MASK,
))
.build(),
);
klass.add_shortcut(
>k::Shortcut::builder()
.action(>k::NamedAction::new("edit-crop.rotate-ccw"))
.trigger(>k::KeyvalTrigger::new(
gdk::Key::R,
gdk::ModifierType::CONTROL_MASK.union(gdk::ModifierType::SHIFT_MASK),
))
.build(),
);
klass.add_shortcut(
>k::Shortcut::builder()
.action(>k::NamedAction::new("edit-crop.apply-crop"))
.trigger(>k::KeyvalTrigger::new(
gdk::Key::Return,
gdk::ModifierType::CONTROL_MASK,
))
.build(),
);
}
fn instance_init(obj: &glib::subclass::InitializingObject) {
obj.init_template();
}
}
#[glib::derived_properties]
impl ObjectImpl for LpEditCrop {
fn constructed(&self) {
self.parent_constructed();
let obj = &*self.obj();
obj.child().set_parent(obj);
self.image.duplicate_from(&obj.original_image());
let actions = gio::SimpleActionGroup::new();
actions.add_action(&gio::PropertyAction::new(
"aspect-ratio",
&*self.selection,
"aspect_ratio",
));
actions.add_action(&gio::PropertyAction::new(
"orientation",
&*self.selection,
"orientation",
));
obj.insert_action_group("edit-crop", Some(&actions));
obj.action_set_enabled("edit-crop.reset", false);
self.selection.connect_cropped_notify(glib::clone!(
#[weak]
obj,
move |_| {
obj.action_set_enabled("edit-crop.reset", obj.imp().is_reset_enabled());
}
));
self.selection.connect_orientation_notify(glib::clone!(
#[weak]
obj,
move |_| {
obj.imp().asepect_ratio_orientation_changed();
}
));
}
fn dispose(&self) {
self.obj().child().unparent();
}
}
impl WidgetImpl for LpEditCrop {
fn root(&self) {
self.parent_root();
let obj = self.obj();
// Select correct orientation based on aspect ratio
obj.handle_error(self.apply_reset());
}
}
impl BinImpl for LpEditCrop {}
impl LpEditCrop {
fn reset_selection(&self) {
self.selection.reset();
}
pub(super) fn apply_crop(&self) {
if let Some(crop) = self.selection.crop_area_image_coord() {
self.add_operation(Operation::Clip(crop));
self.reset_selection();
}
}
fn apply_mirror_horizontally(&self) {
self.apply_crop();
self.add_operation(Operation::MirrorHorizontally);
self.reset_selection();
}
fn apply_mirror_vertically(&self) {
self.apply_crop();
self.add_operation(Operation::MirrorVertically);
self.reset_selection();
}
fn apply_rotate_cw(&self) {
self.apply_crop();
self.add_operation(Operation::Rotate(gufo_common::orientation::Rotation::_270));
self.reset_selection();
}
fn apply_rotate_ccw(&self) {
self.apply_crop();
self.add_operation(Operation::Rotate(gufo_common::orientation::Rotation::_90));
self.reset_selection();
}
/// Undo all operations that can be done in this window
fn apply_reset(&self) -> Result<(), EditingError> {
let obj = self.obj();
self.image
.set_operations(Some(Arc::new(Operations::new(Vec::new()))))?;
obj.edit_window().set_operations(None);
self.reset_selection();
let res = self.obj().activate_action(
"edit-crop.aspect-ratio",
Some(&LpAspectRatio::default().to_variant()),
);
if let Err(err) = res {
log::error!("Failed to call action edit-crop.aspect-ratio: {err}");
}
let (w, h) = self.image.image_size();
let orientation = if h > w {
LpOrientation::Portrait
} else {
LpOrientation::Landscape
};
let res = self
.obj()
.activate_action("edit-crop.orientation", Some(&orientation.to_variant()));
if let Err(err) = res {
log::error!("Failed to call action edit-crop.orientation: {err}");
}
self.obj().action_set_enabled("edit-crop.reset", false);
Ok(())
}
fn add_operation(&self, operation: Operation) {
let obj = self.obj();
let edit_window = obj.edit_window();
let previous_operiatons = edit_window.operations();
edit_window.add_operation(operation);
let res = self.image.set_operations(edit_window.operations());
if res.is_err() {
obj.handle_error(res);
// Reset to set of hopefully working operations
edit_window.set_operations(previous_operiatons);
} else {
obj.action_set_enabled("edit-crop.reset", true);
}
}
fn is_reset_enabled(&self) -> bool {
self.obj().edit_window().operations().is_some() || self.selection.cropped()
}
fn asepect_ratio_orientation_changed(&self) {
match self.selection.orientation() {
LpOrientation::Landscape => {
self.aspect_ratio_buttons
.remove_css_class("button-icons-portrait");
}
LpOrientation::Portrait => {
self.aspect_ratio_buttons
.add_css_class("button-icons-portrait");
}
}
}
}
}
glib::wrapper! {
pub struct LpEditCrop(ObjectSubclass)
@extends gtk::Widget, adw::Bin,
@implements gtk::Buildable, gtk::Accessible, gtk::ConstraintTarget;
}
impl LpEditCrop {
pub fn new(original_image: LpImage) -> Self {
let obj: Self = glib::Object::builder()
.property("original_image", original_image)
.build();
obj
}
pub fn selection(&self) -> LpEditCropSelection {
self.imp().selection.clone()
}
fn handle_error(&self, res: Result<(), EditingError>) {
if let Err(err) = res {
self.window_show_error(
&gettext("Failed to Edit Image"),
&format!("Failed to edit image: {err}"),
ErrorType::General,
);
}
}
pub fn apply_crop(&self) {
self.imp().apply_crop();
}
pub fn image(&self) -> LpImage {
self.imp().image.clone()
}
}