feat!(dialog): refactor and support rfd as file_chooser provider
This commit is contained in:
Michael Aaron Murphy
Michael Murphy
parent
b09b3db81a
commit
0bef593ba4
9 changed files with 618 additions and 362 deletions
|
|
@ -2,219 +2,147 @@
|
|||
// SPDX-License-Identifier: MPL-2.0
|
||||
|
||||
//! Dialogs for opening and save files.
|
||||
//!
|
||||
//! # Features
|
||||
//!
|
||||
//! - On Linux, the `xdg-portal` feature will use XDG Portal dialogs.
|
||||
//! - Alternatively, `rfd` can be used for platform support beyond Linux.
|
||||
//!
|
||||
//! # Open a file
|
||||
//!
|
||||
//! ```no_run
|
||||
//! cosmic::command::future(async {
|
||||
//! use cosmic::dialog::file_chooser;
|
||||
//!
|
||||
//! let dialog = file_chooser::open::Dialog::new()
|
||||
//! .title("Choose a file");
|
||||
//!
|
||||
//! match dialog.open_file().await {
|
||||
//! Ok(response) => println!("selected to open {:?}", response.url()),
|
||||
//!
|
||||
//! Err(file_chooser::Error::Cancelled) => (),
|
||||
//!
|
||||
//! Err(why) => eprintln!("error selecting file to open: {why:?}")
|
||||
//! }
|
||||
//! });
|
||||
//! ```
|
||||
//!
|
||||
//! # Open multiple files
|
||||
//!
|
||||
//! ```no_run
|
||||
//! cosmic::command::future(async {
|
||||
//! use cosmic::dialog::file_chooser;
|
||||
//!
|
||||
//! let dialog = file_chooser::open::Dialog::new()
|
||||
//! .title("Choose multiple files");
|
||||
//!
|
||||
//! match dialog.open_files().await {
|
||||
//! Ok(response) => println!("selected to open {:?}", response.urls()),
|
||||
//!
|
||||
//! Err(file_chooser::Error::Cancelled) => (),
|
||||
//!
|
||||
//! Err(why) => eprintln!("error selecting file(s) to open: {why:?}")
|
||||
//! }
|
||||
//! });
|
||||
//! ```
|
||||
//!
|
||||
//! # Open a folder
|
||||
//!
|
||||
//! ```no_run
|
||||
//! cosmic::command::future(async {
|
||||
//! use cosmic::dialog::file_chooser;
|
||||
//!
|
||||
//! let dialog = file_chooser::open::Dialog::new()
|
||||
//! .title("Choose a folder");
|
||||
//!
|
||||
//! match dialog.open_folder().await {
|
||||
//! Ok(response) => println!("selected to open {:?}", response.url()),
|
||||
//!
|
||||
//! Err(file_chooser::Error::Cancelled) => (),
|
||||
//!
|
||||
//! Err(why) => eprintln!("error selecting folder to open: {why:?}")
|
||||
//! }
|
||||
//! });
|
||||
//! ```
|
||||
//!
|
||||
//! # Open multiple folders
|
||||
//!
|
||||
//! ```no_run
|
||||
//! cosmic::command::future(async {
|
||||
//! use cosmic::dialog::file_chooser;
|
||||
//!
|
||||
//! let dialog = file_chooser::open::Dialog::new()
|
||||
//! .title("Choose a folder");
|
||||
//!
|
||||
//! match dialog.open_folders().await {
|
||||
//! Ok(response) => println!("selected to open {:?}", response.urls()),
|
||||
//!
|
||||
//! Err(file_chooser::Error::Cancelled) => (),
|
||||
//!
|
||||
//! Err(why) => eprintln!("error selecting folder(s) to open: {why:?}")
|
||||
//! }
|
||||
//! });
|
||||
//! ```
|
||||
|
||||
/// Open file dialog.
|
||||
pub mod open;
|
||||
|
||||
/// Save file dialog.
|
||||
pub mod save;
|
||||
|
||||
pub use ashpd::desktop::file_chooser::{Choice, FileFilter, SelectedFiles};
|
||||
use iced::futures::{channel, SinkExt, StreamExt};
|
||||
use iced::{Command, Subscription};
|
||||
use std::sync::atomic::{AtomicBool, Ordering};
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub use ashpd::desktop::file_chooser::{Choice, FileFilter};
|
||||
|
||||
use thiserror::Error;
|
||||
|
||||
/// Prevents duplicate file chooser dialog requests.
|
||||
static OPENED: AtomicBool = AtomicBool::new(false);
|
||||
|
||||
/// Whether a file chooser dialog is currently active.
|
||||
fn dialog_active() -> bool {
|
||||
OPENED.load(Ordering::Relaxed)
|
||||
/// A file filter, to limit the available file choices to certain extensions.
|
||||
#[cfg(feature = "rfd")]
|
||||
#[must_use]
|
||||
pub struct FileFilter {
|
||||
description: String,
|
||||
extensions: Vec<String>,
|
||||
}
|
||||
|
||||
/// Sets the existence of a file chooser dialog.
|
||||
fn dialog_active_set(value: bool) {
|
||||
OPENED.store(value, Ordering::SeqCst);
|
||||
}
|
||||
|
||||
/// Creates an [`open::Dialog`] if no other file chooser exists.
|
||||
pub fn open_file() -> Option<open::Dialog> {
|
||||
if dialog_active() {
|
||||
None
|
||||
} else {
|
||||
Some(open::Dialog::new())
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a [`save::Dialog`] if no other file chooser exists.
|
||||
pub fn save_file() -> Option<save::Dialog> {
|
||||
if dialog_active() {
|
||||
None
|
||||
} else {
|
||||
Some(save::Dialog::new())
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a subscription for file chooser events.
|
||||
pub fn subscription<M, H>(handle: H) -> Subscription<M>
|
||||
where
|
||||
M: Send + 'static,
|
||||
H: Fn(Message) -> M + Send + Sync + 'static,
|
||||
{
|
||||
let type_id = std::any::TypeId::of::<Handler<M, H>>();
|
||||
|
||||
iced::subscription::channel(type_id, 1, move |output| async move {
|
||||
let mut state = Handler {
|
||||
active: None,
|
||||
handle,
|
||||
output,
|
||||
};
|
||||
|
||||
loop {
|
||||
let (sender, mut receiver) = channel::mpsc::channel(1);
|
||||
|
||||
state.emit(Message::Init(Sender(sender))).await;
|
||||
|
||||
while let Some(request) = receiver.next().await {
|
||||
match request {
|
||||
Request::Close => state.close().await,
|
||||
|
||||
Request::Open(dialog) => {
|
||||
state.open(dialog).await;
|
||||
dialog_active_set(false);
|
||||
}
|
||||
|
||||
Request::Save(dialog) => {
|
||||
state.save(dialog).await;
|
||||
dialog_active_set(false);
|
||||
}
|
||||
|
||||
Request::Response => state.response().await,
|
||||
}
|
||||
}
|
||||
#[cfg(feature = "rfd")]
|
||||
impl FileFilter {
|
||||
pub fn new(description: impl Into<String>) -> Self {
|
||||
Self {
|
||||
description: description.into(),
|
||||
extensions: Vec::new(),
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
pub fn extension(mut self, extension: impl Into<String>) -> Self {
|
||||
self.extensions.push(extension.into());
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
/// Errors that my occur when interacting with the file chooser subscription
|
||||
#[derive(Debug, Error)]
|
||||
pub enum Error {
|
||||
#[error("dialog request cancelled")]
|
||||
Cancelled,
|
||||
#[error("dialog close failed")]
|
||||
Close(#[source] ashpd::Error),
|
||||
#[error("dialog open failed")]
|
||||
Open(#[source] ashpd::Error),
|
||||
Close(#[source] DialogError),
|
||||
#[error("open dialog failed")]
|
||||
Open(#[source] DialogError),
|
||||
#[error("dialog response failed")]
|
||||
Response(#[source] ashpd::Error),
|
||||
Response(#[source] DialogError),
|
||||
#[error("save dialog failed")]
|
||||
Save(#[source] DialogError),
|
||||
#[error("could not set directory")]
|
||||
SetDirectory(#[source] DialogError),
|
||||
#[error("could not set absolute path for file name")]
|
||||
SetAbsolutePath(#[source] DialogError),
|
||||
#[error("path from dialog was not absolute")]
|
||||
UrlAbsolute,
|
||||
}
|
||||
|
||||
/// Requests for the file chooser subscription
|
||||
enum Request {
|
||||
Close,
|
||||
Open(open::Dialog),
|
||||
Save(save::Dialog),
|
||||
Response,
|
||||
}
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub type DialogError = ashpd::Error;
|
||||
|
||||
/// Messages from the file chooser subscription.
|
||||
pub enum Message {
|
||||
Closed,
|
||||
Err(Error),
|
||||
Init(Sender),
|
||||
Opened,
|
||||
Selected(SelectedFiles),
|
||||
}
|
||||
|
||||
/// Sends requests to the file chooser subscription.
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct Sender(channel::mpsc::Sender<Request>);
|
||||
|
||||
impl Sender {
|
||||
/// Creates a [`Command`] that closes a file chooser dialog.
|
||||
pub fn close(&mut self) -> Command<()> {
|
||||
let mut sender = self.0.clone();
|
||||
|
||||
crate::command::future(async move {
|
||||
let _res = sender.send(Request::Close).await;
|
||||
()
|
||||
})
|
||||
}
|
||||
|
||||
/// Creates a [`Command`] that opens the file chooser.
|
||||
pub fn open(&mut self, dialog: open::Dialog) -> Command<()> {
|
||||
dialog_active_set(true);
|
||||
let mut sender = self.0.clone();
|
||||
|
||||
crate::command::future(async move {
|
||||
let _res = sender.send(Request::Open(dialog)).await;
|
||||
()
|
||||
})
|
||||
}
|
||||
|
||||
/// Creates a [`Command`] that requests the response from a file chooser dialog.
|
||||
pub fn response(&mut self) -> Command<()> {
|
||||
let mut sender = self.0.clone();
|
||||
|
||||
crate::command::future(async move {
|
||||
let _res = sender.send(Request::Response).await;
|
||||
()
|
||||
})
|
||||
}
|
||||
|
||||
/// Creates a [`Command`] that opens a new save file dialog.
|
||||
pub fn save(&mut self, dialog: save::Dialog) -> Command<()> {
|
||||
dialog_active_set(true);
|
||||
let mut sender = self.0.clone();
|
||||
|
||||
crate::command::future(async move {
|
||||
let _res = sender.send(Request::Save(dialog)).await;
|
||||
()
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
struct Handler<M, Handle: Fn(Message) -> M> {
|
||||
active: Option<ashpd::desktop::Request<SelectedFiles>>,
|
||||
handle: Handle,
|
||||
output: channel::mpsc::Sender<M>,
|
||||
}
|
||||
|
||||
impl<M, Handle: Fn(Message) -> M> Handler<M, Handle> {
|
||||
/// Emits close request if there is an active dialog request.
|
||||
async fn close(&mut self) {
|
||||
if let Some(request) = self.active.take() {
|
||||
if let Err(why) = request.close().await {
|
||||
self.emit(Message::Err(Error::Close(why))).await;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async fn emit(&mut self, response: Message) {
|
||||
let _res = self.output.send((self.handle)(response)).await;
|
||||
}
|
||||
|
||||
/// Creates a new dialog, and closes any prior active dialogs.
|
||||
async fn open(&mut self, dialog: open::Dialog) {
|
||||
let response = match open::create(dialog).await {
|
||||
Ok(request) => {
|
||||
self.active = Some(request);
|
||||
Message::Opened
|
||||
}
|
||||
Err(why) => Message::Err(Error::Open(why)),
|
||||
};
|
||||
|
||||
self.emit(response).await;
|
||||
}
|
||||
|
||||
/// Collects selected files from the active dialog.
|
||||
async fn response(&mut self) {
|
||||
if let Some(request) = self.active.as_ref() {
|
||||
let response = match request.response() {
|
||||
Ok(selected) => Message::Selected(selected),
|
||||
Err(why) => Message::Err(Error::Response(why)),
|
||||
};
|
||||
|
||||
self.emit(response).await;
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a new dialog, and closes any prior active dialogs.
|
||||
async fn save(&mut self, dialog: save::Dialog) {
|
||||
let response = match save::create(dialog).await {
|
||||
Ok(request) => {
|
||||
self.active = Some(request);
|
||||
Message::Opened
|
||||
}
|
||||
Err(why) => Message::Err(Error::Open(why)),
|
||||
};
|
||||
|
||||
self.emit(response).await;
|
||||
}
|
||||
}
|
||||
#[cfg(feature = "rfd")]
|
||||
#[derive(Debug, Error)]
|
||||
#[error("no file selected")]
|
||||
pub struct DialogError {}
|
||||
|
|
|
|||
|
|
@ -6,85 +6,318 @@
|
|||
//! Check out the [open-dialog](https://github.com/pop-os/libcosmic/tree/master/examples/open-dialog)
|
||||
//! example in our repository.
|
||||
|
||||
use derive_setters::Setters;
|
||||
use iced::Command;
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub use portal::{file, files, folder, folders, FileResponse, MultiFileResponse};
|
||||
|
||||
/// A builder for an open file dialog, passed as a request by a [`Sender`]
|
||||
#[derive(Setters)]
|
||||
#[cfg(feature = "rfd")]
|
||||
pub use rust_fd::{file, files, folder, folders, FileResponse, MultiFileResponse};
|
||||
|
||||
use super::Error;
|
||||
use std::path::PathBuf;
|
||||
|
||||
/// A builder for an open file dialog
|
||||
#[derive(derive_setters::Setters)]
|
||||
#[must_use]
|
||||
pub struct Dialog {
|
||||
/// The label for the dialog's window title.
|
||||
#[setters(into)]
|
||||
title: String,
|
||||
|
||||
/// The label for the accept button. Mnemonic underlines are allowed.
|
||||
#[setters(strip_option)]
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
#[setters(skip)]
|
||||
accept_label: Option<String>,
|
||||
|
||||
/// Whether to select for folders instead of files. Default is to select files.
|
||||
include_directories: bool,
|
||||
/// Sets the starting directory of the dialog.
|
||||
#[setters(into, strip_option)]
|
||||
#[allow(dead_code)] // TODO: ashpd does not expose this yet
|
||||
directory: Option<PathBuf>,
|
||||
|
||||
/// Set starting file name of the dialog.
|
||||
#[setters(into, strip_option)]
|
||||
#[allow(dead_code)] // TODO: ashpd does not expose this yet
|
||||
file_name: Option<String>,
|
||||
|
||||
/// Modal dialogs require user input before continuing the program.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
#[setters(skip)]
|
||||
modal: bool,
|
||||
|
||||
/// Whether to allow selection of multiple files. Default is no.
|
||||
multiple_files: bool,
|
||||
|
||||
/// Adds a list of choices.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
#[setters(skip)]
|
||||
choices: Vec<super::Choice>,
|
||||
|
||||
/// Specifies the default file filter.
|
||||
#[setters(into)]
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
#[setters(skip)]
|
||||
current_filter: Option<super::FileFilter>,
|
||||
|
||||
/// A collection of file filters.
|
||||
filters: Vec<super::FileFilter>,
|
||||
#[setters(skip)]
|
||||
pub(self) filters: Vec<super::FileFilter>,
|
||||
}
|
||||
|
||||
impl Dialog {
|
||||
pub(super) const fn new() -> Self {
|
||||
pub const fn new() -> Self {
|
||||
Self {
|
||||
title: String::new(),
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
accept_label: None,
|
||||
include_directories: false,
|
||||
directory: None,
|
||||
file_name: None,
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
modal: true,
|
||||
multiple_files: false,
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
current_filter: None,
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
choices: Vec::new(),
|
||||
filters: Vec::new(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a [`Command`] which opens the dialog.
|
||||
pub fn create(self, sender: &mut super::Sender) -> Command<()> {
|
||||
sender.open(self)
|
||||
/// The label for the accept button. Mnemonic underlines are allowed.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub fn accept_label(mut self, label: impl Into<String>) -> Self {
|
||||
self.accept_label = Some(label.into());
|
||||
self
|
||||
}
|
||||
|
||||
/// Adds a choice.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub fn choice(mut self, choice: impl Into<super::Choice>) -> Self {
|
||||
self.choices.push(choice.into());
|
||||
self
|
||||
}
|
||||
|
||||
/// Specifies the default file filter.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub fn current_filter(mut self, filter: impl Into<super::FileFilter>) -> Self {
|
||||
self.current_filter = Some(filter.into());
|
||||
self
|
||||
}
|
||||
|
||||
/// Adds a files filter.
|
||||
pub fn filter(mut self, filter: impl Into<super::FileFilter>) -> Self {
|
||||
self.filters.push(filter.into());
|
||||
self
|
||||
}
|
||||
|
||||
/// Modal dialogs require user input before continuing the program.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub fn modal(mut self, modal: bool) -> Self {
|
||||
self.modal = modal;
|
||||
self
|
||||
}
|
||||
|
||||
/// Create an open file dialog.
|
||||
pub async fn open_file(self) -> Result<FileResponse, Error> {
|
||||
file(self).await
|
||||
}
|
||||
|
||||
/// Create an open file dialog with multiple file select.
|
||||
pub async fn open_files(self) -> Result<MultiFileResponse, Error> {
|
||||
files(self).await
|
||||
}
|
||||
|
||||
/// Create an open folder dialog.
|
||||
pub async fn open_folder(self) -> Result<FileResponse, Error> {
|
||||
folder(self).await
|
||||
}
|
||||
|
||||
/// Create an open folder dialog with multi file select.
|
||||
pub async fn open_folders(self) -> Result<MultiFileResponse, Error> {
|
||||
folders(self).await
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a new file dialog, and begins to await its responses.
|
||||
pub(super) async fn create(
|
||||
dialog: Dialog,
|
||||
) -> ashpd::Result<ashpd::desktop::Request<super::SelectedFiles>> {
|
||||
ashpd::desktop::file_chooser::OpenFileRequest::default()
|
||||
.title(Some(dialog.title.as_str()))
|
||||
.accept_label(dialog.accept_label.as_deref())
|
||||
.directory(dialog.include_directories)
|
||||
.modal(dialog.modal)
|
||||
.multiple(dialog.multiple_files)
|
||||
.choices(dialog.choices)
|
||||
.filters(dialog.filters)
|
||||
.current_filter(dialog.current_filter)
|
||||
.send()
|
||||
.await
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
mod portal {
|
||||
use super::Dialog;
|
||||
use crate::dialog::file_chooser::Error;
|
||||
use ashpd::desktop::file_chooser::SelectedFiles;
|
||||
use url::Url;
|
||||
|
||||
fn error_or_cancel(error: ashpd::Error) -> Error {
|
||||
if let ashpd::Error::Response(ashpd::desktop::ResponseError::Cancelled) = error {
|
||||
Error::Cancelled
|
||||
} else {
|
||||
Error::Open(error)
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a new file dialog, and begins to await its responses.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub async fn create(
|
||||
dialog: super::Dialog,
|
||||
folders: bool,
|
||||
multiple: bool,
|
||||
) -> Result<ashpd::desktop::Request<SelectedFiles>, Error> {
|
||||
// TODO: Set window identifier
|
||||
ashpd::desktop::file_chooser::OpenFileRequest::default()
|
||||
.title(Some(dialog.title.as_str()))
|
||||
.accept_label(dialog.accept_label.as_deref())
|
||||
.directory(folders)
|
||||
.modal(dialog.modal)
|
||||
.multiple(multiple)
|
||||
.choices(dialog.choices)
|
||||
.filters(dialog.filters)
|
||||
.current_filter(dialog.current_filter)
|
||||
.send()
|
||||
.await
|
||||
.map_err(error_or_cancel)
|
||||
}
|
||||
|
||||
fn file_response(
|
||||
request: ashpd::desktop::Request<SelectedFiles>,
|
||||
) -> Result<FileResponse, Error> {
|
||||
request
|
||||
.response()
|
||||
.map(FileResponse)
|
||||
.map_err(error_or_cancel)
|
||||
}
|
||||
|
||||
fn multi_file_response(
|
||||
request: ashpd::desktop::Request<SelectedFiles>,
|
||||
) -> Result<MultiFileResponse, Error> {
|
||||
request
|
||||
.response()
|
||||
.map(MultiFileResponse)
|
||||
.map_err(error_or_cancel)
|
||||
}
|
||||
|
||||
pub async fn file(dialog: Dialog) -> Result<FileResponse, Error> {
|
||||
file_response(create(dialog, false, false).await?)
|
||||
}
|
||||
|
||||
pub async fn files(dialog: Dialog) -> Result<MultiFileResponse, Error> {
|
||||
multi_file_response(create(dialog, false, true).await?)
|
||||
}
|
||||
|
||||
pub async fn folder(dialog: Dialog) -> Result<FileResponse, Error> {
|
||||
file_response(create(dialog, true, false).await?)
|
||||
}
|
||||
|
||||
pub async fn folders(dialog: Dialog) -> Result<MultiFileResponse, Error> {
|
||||
multi_file_response(create(dialog, true, true).await?)
|
||||
}
|
||||
|
||||
/// A dialog response containing the selected file or folder.
|
||||
pub struct FileResponse(pub SelectedFiles);
|
||||
|
||||
impl FileResponse {
|
||||
pub fn choices(&self) -> &[(String, String)] {
|
||||
self.0.choices()
|
||||
}
|
||||
|
||||
pub fn url(&self) -> &Url {
|
||||
self.0.uris().first().expect("no files selected")
|
||||
}
|
||||
}
|
||||
|
||||
/// A dialog response containing the selected file(s) or folder(s).
|
||||
pub struct MultiFileResponse(pub SelectedFiles);
|
||||
|
||||
impl MultiFileResponse {
|
||||
pub fn choices(&self) -> &[(String, String)] {
|
||||
self.0.choices()
|
||||
}
|
||||
|
||||
pub fn urls(&self) -> &[Url] {
|
||||
self.0.uris()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "rfd")]
|
||||
mod rust_fd {
|
||||
use super::Dialog;
|
||||
use crate::dialog::file_chooser::Error;
|
||||
use url::Url;
|
||||
|
||||
pub fn create(dialog: Dialog) -> rfd::AsyncFileDialog {
|
||||
let mut builder = rfd::AsyncFileDialog::new().set_title(dialog.title);
|
||||
|
||||
if let Some(directory) = dialog.directory {
|
||||
builder = builder.set_directory(directory);
|
||||
}
|
||||
|
||||
if let Some(file_name) = dialog.file_name {
|
||||
builder = builder.set_file_name(file_name);
|
||||
}
|
||||
|
||||
for filter in dialog.filters {
|
||||
builder = builder.add_filter(filter.description, &filter.extensions);
|
||||
}
|
||||
|
||||
builder
|
||||
}
|
||||
|
||||
fn file_response(request: Option<rfd::FileHandle>) -> Result<FileResponse, Error> {
|
||||
if let Some(handle) = request {
|
||||
let url = Url::from_file_path(handle.path()).map_err(|_| Error::UrlAbsolute)?;
|
||||
|
||||
return Ok(FileResponse(url));
|
||||
}
|
||||
|
||||
Err(Error::Cancelled)
|
||||
}
|
||||
|
||||
fn multi_file_response(
|
||||
request: Option<Vec<rfd::FileHandle>>,
|
||||
) -> Result<MultiFileResponse, Error> {
|
||||
if let Some(handles) = request {
|
||||
let mut urls = Vec::with_capacity(handles.len());
|
||||
|
||||
for handle in &handles {
|
||||
urls.push(Url::from_file_path(handle.path()).map_err(|()| Error::UrlAbsolute)?);
|
||||
}
|
||||
|
||||
return Ok(MultiFileResponse(urls));
|
||||
}
|
||||
|
||||
Err(Error::Cancelled)
|
||||
}
|
||||
|
||||
pub async fn file(dialog: Dialog) -> Result<FileResponse, Error> {
|
||||
file_response(create(dialog).pick_file().await)
|
||||
}
|
||||
|
||||
pub async fn files(dialog: Dialog) -> Result<MultiFileResponse, Error> {
|
||||
multi_file_response(create(dialog).pick_files().await)
|
||||
}
|
||||
|
||||
pub async fn folder(dialog: Dialog) -> Result<FileResponse, Error> {
|
||||
file_response(create(dialog).pick_folder().await)
|
||||
}
|
||||
|
||||
pub async fn folders(dialog: Dialog) -> Result<MultiFileResponse, Error> {
|
||||
multi_file_response(create(dialog).pick_folders().await)
|
||||
}
|
||||
|
||||
/// A dialog response containing the selected file or folder.
|
||||
pub struct FileResponse(Url);
|
||||
|
||||
impl FileResponse {
|
||||
pub fn choices(&self) -> &[(String, String)] {
|
||||
&[]
|
||||
}
|
||||
|
||||
pub fn url(&self) -> &Url {
|
||||
&self.0
|
||||
}
|
||||
}
|
||||
|
||||
/// A dialog response containing the selected file(s) or folder(s).
|
||||
pub struct MultiFileResponse(Vec<Url>);
|
||||
|
||||
impl MultiFileResponse {
|
||||
pub fn choices(&self) -> &[(String, String)] {
|
||||
&[]
|
||||
}
|
||||
|
||||
pub fn urls(&self) -> &[Url] {
|
||||
&self.0
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,94 +6,201 @@
|
|||
//! Check out the [open-dialog](https://github.com/pop-os/libcosmic/tree/master/examples/open-dialog)
|
||||
//! example in our repository.
|
||||
|
||||
use derive_setters::Setters;
|
||||
use iced::Command;
|
||||
use std::path::{Path, PathBuf};
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub use portal::{file, Response};
|
||||
|
||||
/// A builder for an save file dialog, passed as a request by a [`Sender`]
|
||||
#[derive(Setters)]
|
||||
#[cfg(feature = "rfd")]
|
||||
pub use rust_fd::{file, Response};
|
||||
|
||||
use super::Error;
|
||||
use std::path::PathBuf;
|
||||
|
||||
/// A builder for an save file dialog.
|
||||
#[derive(derive_setters::Setters)]
|
||||
#[must_use]
|
||||
pub struct Dialog {
|
||||
/// The label for the dialog's window title.
|
||||
title: String,
|
||||
|
||||
/// The label for the accept button. Mnemonic underlines are allowed.
|
||||
#[setters(strip_option)]
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
#[setters(skip)]
|
||||
accept_label: Option<String>,
|
||||
|
||||
/// Modal dialogs require user input before continuing the program.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
#[setters(skip)]
|
||||
modal: bool,
|
||||
|
||||
/// Sets the current file name.
|
||||
/// Set starting file name of the dialog.
|
||||
#[setters(strip_option)]
|
||||
current_name: Option<String>,
|
||||
file_name: Option<String>,
|
||||
|
||||
/// Sets the current folder.
|
||||
/// Sets the starting directory of the dialog.
|
||||
#[setters(strip_option)]
|
||||
current_folder: Option<PathBuf>,
|
||||
directory: Option<PathBuf>,
|
||||
|
||||
/// Sets the absolute path of the file
|
||||
#[setters(strip_option)]
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
#[setters(skip)]
|
||||
current_file: Option<PathBuf>,
|
||||
|
||||
/// Adds a list of choices.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
#[setters(skip)]
|
||||
choices: Vec<super::Choice>,
|
||||
|
||||
/// Specifies the default file filter.
|
||||
#[setters(into)]
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
#[setters(skip)]
|
||||
current_filter: Option<super::FileFilter>,
|
||||
|
||||
/// A collection of file filters.
|
||||
#[setters(skip)]
|
||||
filters: Vec<super::FileFilter>,
|
||||
}
|
||||
|
||||
impl Dialog {
|
||||
pub(super) const fn new() -> Self {
|
||||
pub const fn new() -> Self {
|
||||
Self {
|
||||
title: String::new(),
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
accept_label: None,
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
modal: true,
|
||||
current_name: None,
|
||||
current_folder: None,
|
||||
file_name: None,
|
||||
directory: None,
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
current_file: None,
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
current_filter: None,
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
choices: Vec::new(),
|
||||
filters: Vec::new(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a [`Command`] which opens the dialog.
|
||||
pub fn create(self, sender: &mut super::Sender) -> Command<()> {
|
||||
sender.save(self)
|
||||
/// The label for the accept button. Mnemonic underlines are allowed.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub fn accept_label(mut self, label: impl Into<String>) -> Self {
|
||||
self.accept_label = Some(label.into());
|
||||
self
|
||||
}
|
||||
|
||||
/// Adds a choice.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub fn choice(mut self, choice: impl Into<super::Choice>) -> Self {
|
||||
self.choices.push(choice.into());
|
||||
self
|
||||
}
|
||||
|
||||
/// Set the current file filter.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub fn current_filter(mut self, filter: impl Into<super::FileFilter>) -> Self {
|
||||
self.current_filter = Some(filter.into());
|
||||
self
|
||||
}
|
||||
|
||||
/// Adds a files filter.
|
||||
pub fn filter(mut self, filter: impl Into<super::FileFilter>) -> Self {
|
||||
self.filters.push(filter.into());
|
||||
self
|
||||
}
|
||||
|
||||
/// Modal dialogs require user input before continuing the program.
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub fn modal(mut self, modal: bool) -> Self {
|
||||
self.modal = modal;
|
||||
self
|
||||
}
|
||||
|
||||
/// Create a save file dialog request.
|
||||
pub async fn save_file(self) -> Result<Response, Error> {
|
||||
file(self).await
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a new file dialog, and begins to await its responses.
|
||||
pub(super) async fn create(
|
||||
dialog: Dialog,
|
||||
) -> ashpd::Result<ashpd::desktop::Request<super::SelectedFiles>> {
|
||||
ashpd::desktop::file_chooser::SaveFileRequest::default()
|
||||
.title(Some(dialog.title.as_str()))
|
||||
.accept_label(dialog.accept_label.as_deref())
|
||||
.modal(dialog.modal)
|
||||
.choices(dialog.choices)
|
||||
.filters(dialog.filters)
|
||||
.current_filter(dialog.current_filter)
|
||||
.current_name(dialog.current_name.as_deref())
|
||||
.current_folder::<&Path>(dialog.current_folder.as_deref())?
|
||||
.current_file::<&Path>(dialog.current_file.as_deref())?
|
||||
.send()
|
||||
.await
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
mod portal {
|
||||
use super::Dialog;
|
||||
use crate::dialog::file_chooser::Error;
|
||||
use ashpd::desktop::file_chooser::SelectedFiles;
|
||||
use std::path::Path;
|
||||
use url::Url;
|
||||
|
||||
/// Create a save file dialog request.
|
||||
pub async fn file(dialog: Dialog) -> Result<Response, Error> {
|
||||
ashpd::desktop::file_chooser::SaveFileRequest::default()
|
||||
.title(Some(dialog.title.as_str()))
|
||||
.accept_label(dialog.accept_label.as_deref())
|
||||
.modal(dialog.modal)
|
||||
.choices(dialog.choices)
|
||||
.filters(dialog.filters)
|
||||
.current_filter(dialog.current_filter)
|
||||
.current_name(dialog.file_name.as_deref())
|
||||
.current_folder::<&Path>(dialog.directory.as_deref())
|
||||
.map_err(Error::SetDirectory)?
|
||||
.current_file::<&Path>(dialog.current_file.as_deref())
|
||||
.map_err(Error::SetAbsolutePath)?
|
||||
.send()
|
||||
.await
|
||||
.map_err(Error::Save)?
|
||||
.response()
|
||||
.map_err(Error::Save)
|
||||
.map(Response)
|
||||
}
|
||||
|
||||
/// A dialog response containing the selected file or folder.
|
||||
pub struct Response(pub SelectedFiles);
|
||||
|
||||
impl Response {
|
||||
pub fn choices(&self) -> &[(String, String)] {
|
||||
self.0.choices()
|
||||
}
|
||||
|
||||
pub fn url(&self) -> Option<&Url> {
|
||||
self.0.uris().first()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "rfd")]
|
||||
mod rust_fd {
|
||||
use super::Dialog;
|
||||
use crate::dialog::file_chooser::Error;
|
||||
use url::Url;
|
||||
|
||||
/// Create a save file dialog request.
|
||||
pub async fn file(dialog: Dialog) -> Result<Response, Error> {
|
||||
let mut request = rfd::AsyncFileDialog::new().set_title(dialog.title);
|
||||
|
||||
if let Some(directory) = dialog.directory {
|
||||
request = request.set_directory(directory);
|
||||
}
|
||||
|
||||
if let Some(file_name) = dialog.file_name {
|
||||
request = request.set_file_name(file_name);
|
||||
}
|
||||
|
||||
for filter in dialog.filters {
|
||||
request = request.add_filter(filter.description, &filter.extensions);
|
||||
}
|
||||
|
||||
if let Some(handle) = request.save_file().await {
|
||||
let url = Url::from_file_path(handle.path()).map_err(|_| Error::UrlAbsolute)?;
|
||||
|
||||
return Ok(Response(Some(url)));
|
||||
}
|
||||
|
||||
Ok(Response(None))
|
||||
}
|
||||
|
||||
/// A dialog response containing the selected file or folder.
|
||||
pub struct Response(Option<Url>);
|
||||
|
||||
impl Response {
|
||||
pub fn url(&self) -> Option<&Url> {
|
||||
self.0.as_ref()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
|
||||
//! Create dialogs for retrieving user input.
|
||||
|
||||
pub use ashpd::WindowIdentifier;
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
pub use ashpd;
|
||||
|
||||
pub mod file_chooser;
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ pub mod command;
|
|||
pub use cosmic_config;
|
||||
pub use cosmic_theme;
|
||||
|
||||
#[cfg(feature = "xdg-portal")]
|
||||
#[cfg(any(feature = "xdg-portal", feature = "rfd"))]
|
||||
pub mod dialog;
|
||||
|
||||
pub mod executor;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue