Add support for file chooser buttons #602

demurgos · 2017-12-03T09:10:54Z

This commit adds support for file chooser buttons. They are represented
as a slice of tuples (text, action). The original function uses
varargs to support an arbitrary number of arguments. This implementation
supports up to 3 buttons.

~~This is a breaking change.~~

See: https://developer.gnome.org/gtk3/stable/GtkFileChooserDialog.html#gtk-file-chooser-dialog-new

EPashkin · 2017-12-03T09:14:41Z

src/file_chooser_dialog.rs

+                0 => ffi::gtk_file_chooser_dialog_new(title.to_glib_none().0, parent.to_glib_none().0, action.to_glib(), ptr::null::<c_char>()),
+                1 => ffi::gtk_file_chooser_dialog_new(title.to_glib_none().0, parent.to_glib_none().0, action.to_glib(), buttons[0].0.to_glib_none().0, buttons[0].1.to_glib(), ptr::null::<c_char>()),
+                2 => {
+                    let second_button_text: *const c_char = buttons[1].0.to_glib_none().0;


This won't work.
You need save Stash to variable and use .0 in function call.

Thanks, I'll fix it.

Fixed in the latest commit

sdroege · 2017-12-03T09:26:31Z

src/file_chooser_dialog.rs

+                    let second_button_text: *const c_char = buttons[1].0.to_glib_none().0;
+                    ffi::gtk_file_chooser_dialog_new(title.to_glib_none().0, parent.to_glib_none().0, action.to_glib(), buttons[0].0.to_glib_none().0, buttons[0].1.to_glib(), second_button_text, buttons[1].1.to_glib(), ptr::null::<c_char>())
+                },
+                _ => {


This hard-coding of 4 different settings for the file chooser is also not ideal, and the usage of the enum prevents adding "custom" buttons to there. Not sure how to fix either of those though, the C API is kind of suboptimal in this regard.

Fixed in the latest commit: instead of silently truncating the buttons, it panics. This is a temporary solution until variadic functions are supported.

EPashkin · 2017-12-03T09:28:21Z

To remove "breaking change" you can just add this as "with_buttons" instead.
IMHO better panic or unimplemented for 4+ buttons.
Also there crate https://crates.io/crates/va_list

demurgos · 2017-12-03T09:31:02Z

Thank you for the helpful reviews. I am not very familiar with these bindings but I'll fix these issues.

Save stash
Use with_buttons to prevent breaking change (ideally, there should only be one function: there is just one function in Gtk)
~~Use va_list or~~ panic if the number of buttons is too high.

sdroege · 2017-12-03T09:31:31Z

The va_list crate only supports x86, x86-64 and arm, that's not a good idea. We'd need rust-lang/rfcs#2137 for solving this properly.

EPashkin · 2017-12-03T09:31:59Z

@sdroege ResponseType still contains __Unknown(i32) so IMHO custom buttons is possible.

demurgos · 2017-12-03T09:32:27Z

Ok, so I'll panic for now.

EPashkin · 2017-12-03T09:39:04Z

@demurgos Please add TODO comment with link to rust-lang/rust#44930

Following the reviews in gtk-rs#602, this commit: - uses the `with_buttons` function instead of modifying `new` to keep backward compatibility. - saves the button texts in `Stash` objects to avoid invalid pointers - panics when the number of buttons is too high (instead of silently truncating the number of buttons)

demurgos · 2017-12-03T10:04:40Z

@EPashkin @sdroege I updated my PR following your comments. Could you take a look at it?

EPashkin · 2017-12-03T10:28:20Z

Please, remove this comment, I will add it to right place (https://github.com/gtk-rs/lgpl-docs) after PR merged

    /// This function creates a `FileChooserDialog` with buttons:
    /// ```
    /// let dialog = FileChooserDialog::with_buttons::<ApplicationWindow>(
    ///   Option::Some("Open File"),
    ///   Option::None,
    ///   FileChooserAction::Open,
    ///   &[("_Cancel", ResponseType::Cancel), ("_Open", ResponseType::Accept)]
    /// );
    /// ```

demurgos · 2017-12-03T10:30:47Z

@EPashkin Done, I removed the doc comment.

EPashkin · 2017-12-03T10:53:48Z

@demurgos I will change doc' example to this. It works for you?

let dialog = FileChooserDialog::with_buttons::<Window>(
  Some("Open File"),
  None,
  FileChooserAction::Open,
  &[("_Cancel", ResponseType::Cancel), ("_Open", ResponseType::Accept)]
);

demurgos · 2017-12-03T10:59:50Z

Yes, this is fine. I was using ApplicationWindow and just copy pasted, but you are right that it is better to simply use Window.

EPashkin · 2017-12-03T11:20:05Z

cc @sdroege and @GuillaumeGomez for final decision.

sdroege · 2017-12-03T11:26:07Z

src/file_chooser_dialog.rs

+                        title.to_glib_none().0,
+                        parent.to_glib_none().0,
+                        action.to_glib(),
+                        first_button_text.0,


Why not just buttons[0].0.to_glib_none().0 here?

For consistency with the other branches.

To be honest, I also do not really understand how Stash works. I just know that when I used a single stash, I had some errors with pointers and adding more stashes fixed it.

sdroege · 2017-12-03T11:26:32Z

Looks good to me except for the comment I just added. Feel free to ignore me on that though if there's a reason

GuillaumeGomez · 2017-12-03T11:39:16Z

I wrote a va_list crate which works on every OS/arch. It's used by a VLC demuxer so I suppose it's fine enough. Maybe give it a look?

demurgos · 2017-12-06T09:07:53Z

@sdroege
I replied to your comment. Is it fine to leave stashes for consistency or do I have to remove it. If I have to remove it, do I have to remove every first_button_text variable or just the one in the "one button" case?

sdroege · 2017-12-06T09:20:18Z

If it's not needed, it seems simpler/shorter to not define new variables for the Stash but just directly use the value

This commit removes the `first_button_text` variable from `FileChooserDialog::with_buttons`, as requested in the PR gtk-rs#602

demurgos · 2017-12-07T11:30:06Z

@sdroege
I removed the variables for the text of the first button. I tested it locally once for 1, 2 and 3 buttons (it works fine).

It is still not clear for me why I can omit the stash for the first button but if I try to do it for the others it breaks.

demurgos · 2017-12-07T12:36:42Z

The CI error seems to be caused by the usage example. Travis tries to compile it even if it's not a complete program.

sdroege · 2017-12-07T15:33:07Z

How does it break for the other buttons? It should work in all cases

demurgos · 2017-12-07T16:07:21Z

I get the wrong text, instead of printing the text of the button 2, it reuses the window title as button labels. I'll try to reproduce it, it may have been an error on my side.

This commit removes the Stash variables from `FileChooserDialog::with_buttons`, as requested in the PR gtk-rs#602

demurgos · 2017-12-07T16:26:52Z

I was not able to reproduce my issue (wrong text when not using the Stash) so I assume the error was on my side. I pushed the version without any local variables.

EPashkin · 2017-12-07T17:50:16Z

src/file_chooser_dialog.rs

+                        action.to_glib(),
+                        buttons[0].0.to_glib_none().0,
+                        buttons[0].1.to_glib(),
+                        (buttons[1].0.to_glib_none() as Stash<*const c_char, str>).0,


Stash IMHO don't needed here and in other places

Forgot that it var_arg :( so rust can't infer type

Exactly, I can omit it for the first text but not for the other ones.

sdroege · 2017-12-08T09:13:40Z

Seems good now?

demurgos · 2017-12-08T09:36:27Z

It's good for me.

demurgos · 2017-12-11T12:14:09Z

@EPashkin @sdroege
Is it possible to advance with this PR?

sdroege · 2017-12-11T14:02:08Z

All good from my side

GuillaumeGomez · 2017-12-11T14:09:57Z

src/file_chooser_dialog.rs

+                    panic!(format!("`FileChooserDialog::with_buttons` does not support 4+ buttons, received {}", buttons.len()))
+                }
+            })
+              .downcast_unchecked()


Please put this call on the previous line, right after }).

Fixed in the latest commit.

GuillaumeGomez · 2017-12-11T14:38:19Z

Well now please squash your commits. Otherwise seems good to me.

This commit adds support for file chooser buttons. They are represented as a slice of tuples `(text, action)`. The original function uses varargs to support an arbitrary number of arguments. This implementation supports up to 3 buttons. **This is a breaking change.** See: https://developer.gnome.org/gtk3/stable/GtkFileChooserDialog.html#gtk-file-chooser-dialog-new Improve file chooser with buttons reliability Following the reviews in gtk-rs#602, this commit: - uses the `with_buttons` function instead of modifying `new` to keep backward compatibility. - saves the button texts in `Stash` objects to avoid invalid pointers - panics when the number of buttons is too high (instead of silently truncating the number of buttons) Remove doc comment for `FileChooserDialog::with_buttons` Remove local variables in `FileChooserDialog::with_buttons` This commit removes the Stash variables from `FileChooserDialog::with_buttons`, as requested in the PR gtk-rs#602 Fix formatting issue Keep `downcast_unchecked` method on the same line as the closing parenthesis of the chopped-down call to `Widget::from_glib_none`.

demurgos · 2017-12-11T15:07:37Z

@GuillaumeGomez
Done, I squashed the commits, it should be ready now 😄

GuillaumeGomez · 2017-12-11T15:13:05Z

Just waiting confirmation from @EPashkin.

EPashkin · 2017-12-11T16:04:48Z

@demurgos Thanks.
@GuillaumeGomez LGFM

This commit adds support for file chooser buttons. They are represented as a slice of tuples `(text, action)`. The original function uses varargs to support an arbitrary number of arguments. This implementation supports up to 3 buttons. **This is a breaking change.** See: https://developer.gnome.org/gtk3/stable/GtkFileChooserDialog.html#gtk-file-chooser-dialog-new Improve file chooser with buttons reliability Following the reviews in gtk-rs#602, this commit: - uses the `with_buttons` function instead of modifying `new` to keep backward compatibility. - saves the button texts in `Stash` objects to avoid invalid pointers - panics when the number of buttons is too high (instead of silently truncating the number of buttons) Remove doc comment for `FileChooserDialog::with_buttons` Remove local variables in `FileChooserDialog::with_buttons` This commit removes the Stash variables from `FileChooserDialog::with_buttons`, as requested in the PR gtk-rs#602 Fix formatting issue Keep `downcast_unchecked` method on the same line as the closing parenthesis of the chopped-down call to `Widget::from_glib_none`.

Add support for file chooser buttons

Async exctraction

EPashkin reviewed Dec 3, 2017

View reviewed changes

sdroege reviewed Dec 3, 2017

View reviewed changes

EPashkin mentioned this pull request Dec 3, 2017

Add doc for FileChooserDialog::with_buttons gtk-rs/lgpl-docs#39

Merged

sdroege reviewed Dec 3, 2017

View reviewed changes

demurgos added a commit to demurgos/gtk that referenced this pull request Dec 7, 2017

Remove extraneous local variable in FileChooserDialog::with_buttons

b046957

This commit removes the `first_button_text` variable from `FileChooserDialog::with_buttons`, as requested in the PR gtk-rs#602

EPashkin mentioned this pull request Dec 7, 2017

Fix doc test gtk-rs/lgpl-docs#40

Merged

demurgos force-pushed the file-chooser-buttons branch from b046957 to b1f268a Compare December 7, 2017 16:23

demurgos added a commit to demurgos/gtk that referenced this pull request Dec 7, 2017

Remove local variable in FileChooserDialog::with_buttons

b1f268a

This commit removes the Stash variables from `FileChooserDialog::with_buttons`, as requested in the PR gtk-rs#602

demurgos force-pushed the file-chooser-buttons branch from b1f268a to 607e824 Compare December 7, 2017 16:24

demurgos added a commit to demurgos/gtk that referenced this pull request Dec 7, 2017

Remove local variables in FileChooserDialog::with_buttons

607e824

This commit removes the Stash variables from `FileChooserDialog::with_buttons`, as requested in the PR gtk-rs#602

EPashkin reviewed Dec 7, 2017

View reviewed changes

GuillaumeGomez reviewed Dec 11, 2017

View reviewed changes

demurgos force-pushed the file-chooser-buttons branch from d5eb9f6 to 06d9c44 Compare December 11, 2017 15:06

GuillaumeGomez merged commit edc7f50 into gtk-rs:master Dec 11, 2017

demurgos deleted the file-chooser-buttons branch December 11, 2017 17:15

vhdirk pushed a commit to vhdirk/gtk-rs that referenced this pull request Jan 16, 2019

Merge pull request gtk-rs#602 from demurgos/file-chooser-buttons

0dd3fd4

Add support for file chooser buttons

alex179ohm pushed a commit to alex179ohm/gtk that referenced this pull request Oct 21, 2019

Merge pull request gtk-rs#602 from EPashkin/async_exctraction

1825132

Async exctraction

Add support for file chooser buttons #602

Add support for file chooser buttons #602

Conversation

demurgos commented Dec 3, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EPashkin commented Dec 3, 2017

demurgos commented Dec 3, 2017 • edited

sdroege commented Dec 3, 2017

EPashkin commented Dec 3, 2017

demurgos commented Dec 3, 2017

EPashkin commented Dec 3, 2017

demurgos commented Dec 3, 2017

EPashkin commented Dec 3, 2017

demurgos commented Dec 3, 2017 • edited

EPashkin commented Dec 3, 2017

demurgos commented Dec 3, 2017

EPashkin commented Dec 3, 2017

Choose a reason for hiding this comment

demurgos Dec 3, 2017 • edited

Choose a reason for hiding this comment

sdroege commented Dec 3, 2017

GuillaumeGomez commented Dec 3, 2017

demurgos commented Dec 6, 2017

sdroege commented Dec 6, 2017

demurgos commented Dec 7, 2017

demurgos commented Dec 7, 2017 • edited

sdroege commented Dec 7, 2017

demurgos commented Dec 7, 2017

demurgos commented Dec 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sdroege commented Dec 8, 2017

demurgos commented Dec 8, 2017

demurgos commented Dec 11, 2017

sdroege commented Dec 11, 2017

Choose a reason for hiding this comment

demurgos Dec 11, 2017 • edited

Choose a reason for hiding this comment

GuillaumeGomez commented Dec 11, 2017

demurgos commented Dec 11, 2017

GuillaumeGomez commented Dec 11, 2017

EPashkin commented Dec 11, 2017

demurgos commented Dec 3, 2017 •

edited

demurgos commented Dec 3, 2017 •

edited

demurgos commented Dec 3, 2017 •

edited

demurgos Dec 3, 2017 •

edited

demurgos commented Dec 7, 2017 •

edited

demurgos Dec 11, 2017 •

edited