From 1d612a12a1960f2f0c539faa68fae7523f583f25 Mon Sep 17 00:00:00 2001 From: Tan Wang Leng Date: Wed, 1 Feb 2017 23:34:21 +0800 Subject: [PATCH 01/12] :apple: Add additional options for Mac's save dialog Support additional attributes available in macOS's NSSavePanel: message, nameFieldLabel and showsTagField --- atom/browser/api/atom_api_dialog.cc | 9 ++++-- .../browser/atom_download_manager_delegate.cc | 1 + atom/browser/common_web_contents_delegate.cc | 2 +- atom/browser/ui/file_dialog.h | 6 ++++ atom/browser/ui/file_dialog_gtk.cc | 3 ++ atom/browser/ui/file_dialog_mac.mm | 31 ++++++++++++++++--- atom/browser/ui/file_dialog_win.cc | 6 ++++ atom/browser/web_dialog_helper.cc | 3 ++ lib/browser/api/dialog.js | 20 +++++++++++- 9 files changed, 72 insertions(+), 9 deletions(-) diff --git a/atom/browser/api/atom_api_dialog.cc b/atom/browser/api/atom_api_dialog.cc index 5d853e2d590..1efb78d72d2 100644 --- a/atom/browser/api/atom_api_dialog.cc +++ b/atom/browser/api/atom_api_dialog.cc @@ -92,6 +92,9 @@ void ShowSaveDialog(const std::string& title, const std::string& button_label, const base::FilePath& default_path, const file_dialog::Filters& filters, + const std::string& message, + const std::string& name_field_label, + const bool& shows_tag_field, atom::NativeWindow* window, mate::Arguments* args) { v8::Local peek = args->PeekNext(); @@ -100,11 +103,13 @@ void ShowSaveDialog(const std::string& title, peek, &callback)) { file_dialog::ShowSaveDialog(window, title, button_label, default_path, - filters, callback); + filters, message, name_field_label, + shows_tag_field, callback); } else { base::FilePath path; if (file_dialog::ShowSaveDialog(window, title, button_label, default_path, - filters, &path)) + filters, message, name_field_label, + shows_tag_field, &path)) args->Return(path); } } diff --git a/atom/browser/atom_download_manager_delegate.cc b/atom/browser/atom_download_manager_delegate.cc index 0213216697a..b92e3e18bc7 100644 --- a/atom/browser/atom_download_manager_delegate.cc +++ b/atom/browser/atom_download_manager_delegate.cc @@ -93,6 +93,7 @@ void AtomDownloadManagerDelegate::OnDownloadPathGenerated( if (path.empty() && file_dialog::ShowSaveDialog(window, item->GetURL().spec(), "", default_path, file_dialog::Filters(), + "", "", false, &path)) { // Remember the last selected download directory. AtomBrowserContext* browser_context = static_cast( diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index ed0fd5e4ba3..c3cca231c31 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -297,7 +297,7 @@ void CommonWebContentsDelegate::DevToolsSaveToFile( file_dialog::Filters filters; base::FilePath default_path(base::FilePath::FromUTF8Unsafe(url)); if (!file_dialog::ShowSaveDialog(owner_window(), url, "", default_path, - filters, &path)) { + filters, "", "", false, &path)) { base::StringValue url_value(url); web_contents_->CallClientFunction( "DevToolsAPI.canceledSaveURL", &url_value, nullptr, nullptr); diff --git a/atom/browser/ui/file_dialog.h b/atom/browser/ui/file_dialog.h index a8703bebf8d..8b2d7f0d99e 100644 --- a/atom/browser/ui/file_dialog.h +++ b/atom/browser/ui/file_dialog.h @@ -58,6 +58,9 @@ bool ShowSaveDialog(atom::NativeWindow* parent_window, const std::string& button_label, const base::FilePath& default_path, const Filters& filters, + const std::string& message, + const std::string& name_field_label, + const bool& shows_tag_field, base::FilePath* path); void ShowSaveDialog(atom::NativeWindow* parent_window, @@ -65,6 +68,9 @@ void ShowSaveDialog(atom::NativeWindow* parent_window, const std::string& button_label, const base::FilePath& default_path, const Filters& filters, + const std::string& message, + const std::string& name_field_label, + const bool& shows_tag_field, const SaveDialogCallback& callback); } // namespace file_dialog diff --git a/atom/browser/ui/file_dialog_gtk.cc b/atom/browser/ui/file_dialog_gtk.cc index 18f53eba6fb..c39281d8f6e 100644 --- a/atom/browser/ui/file_dialog_gtk.cc +++ b/atom/browser/ui/file_dialog_gtk.cc @@ -275,6 +275,9 @@ bool ShowSaveDialog(atom::NativeWindow* parent_window, const std::string& button_label, const base::FilePath& default_path, const Filters& filters, + const std::string& message, + const std::string& name_field_label, + const bool& shows_tag_field, base::FilePath* path) { FileChooserDialog save_dialog(GTK_FILE_CHOOSER_ACTION_SAVE, parent_window, title, button_label, default_path, filters); diff --git a/atom/browser/ui/file_dialog_mac.mm b/atom/browser/ui/file_dialog_mac.mm index 9492fe90ee1..ee07d2af004 100644 --- a/atom/browser/ui/file_dialog_mac.mm +++ b/atom/browser/ui/file_dialog_mac.mm @@ -47,13 +47,24 @@ void SetupDialog(NSSavePanel* dialog, const std::string& title, const std::string& button_label, const base::FilePath& default_path, - const Filters& filters) { + const Filters& filters, + const std::string& message, + const std::string& name_field_label, + const bool& shows_tag_field) { if (!title.empty()) [dialog setTitle:base::SysUTF8ToNSString(title)]; if (!button_label.empty()) [dialog setPrompt:base::SysUTF8ToNSString(button_label)]; + if (!message.empty()) + [dialog setMessage:base::SysUTF8ToNSString(message)]; + + if (!name_field_label.empty()) + [dialog setNameFieldLabel:base::SysUTF8ToNSString(name_field_label)]; + + [dialog setShowsTagField:shows_tag_field]; + NSString* default_dir = nil; NSString* default_filename = nil; if (!default_path.empty()) { @@ -127,7 +138,8 @@ bool ShowOpenDialog(atom::NativeWindow* parent_window, DCHECK(paths); NSOpenPanel* dialog = [NSOpenPanel openPanel]; - SetupDialog(dialog, title, button_label, default_path, filters); +// TODO yamgent: Fix this + SetupDialog(dialog, title, button_label, default_path, filters, "", "", false); SetupDialogForProperties(dialog, properties); int chosen = RunModalDialog(dialog, parent_window); @@ -147,7 +159,8 @@ void ShowOpenDialog(atom::NativeWindow* parent_window, const OpenDialogCallback& c) { NSOpenPanel* dialog = [NSOpenPanel openPanel]; - SetupDialog(dialog, title, button_label, default_path, filters); +// TODO yamgent: Fix this + SetupDialog(dialog, title, button_label, default_path, filters, "", "", false); SetupDialogForProperties(dialog, properties); // Duplicate the callback object here since c is a reference and gcd would @@ -172,11 +185,15 @@ bool ShowSaveDialog(atom::NativeWindow* parent_window, const std::string& button_label, const base::FilePath& default_path, const Filters& filters, + const std::string& message, + const std::string& name_field_label, + const bool& shows_tag_field, base::FilePath* path) { DCHECK(path); NSSavePanel* dialog = [NSSavePanel savePanel]; - SetupDialog(dialog, title, button_label, default_path, filters); + SetupDialog(dialog, title, button_label, default_path, filters, message, + name_field_label, shows_tag_field); int chosen = RunModalDialog(dialog, parent_window); if (chosen == NSFileHandlingPanelCancelButton || ![[dialog URL] isFileURL]) @@ -191,10 +208,14 @@ void ShowSaveDialog(atom::NativeWindow* parent_window, const std::string& button_label, const base::FilePath& default_path, const Filters& filters, + const std::string& message, + const std::string& name_field_label, + const bool& shows_tag_field, const SaveDialogCallback& c) { NSSavePanel* dialog = [NSSavePanel savePanel]; - SetupDialog(dialog, title, button_label, default_path, filters); + SetupDialog(dialog, title, button_label, default_path, filters, message, + name_field_label, shows_tag_field); [dialog setCanSelectHiddenExtension:YES]; __block SaveDialogCallback callback = c; diff --git a/atom/browser/ui/file_dialog_win.cc b/atom/browser/ui/file_dialog_win.cc index 8e973432f5a..2c801756248 100644 --- a/atom/browser/ui/file_dialog_win.cc +++ b/atom/browser/ui/file_dialog_win.cc @@ -268,6 +268,9 @@ bool ShowSaveDialog(atom::NativeWindow* parent_window, const std::string& button_label, const base::FilePath& default_path, const Filters& filters, + const std::string& message, + const std::string& name_field_label, + const bool& shows_tag_field, base::FilePath* path) { FileDialog save_dialog( default_path, title, button_label, filters, @@ -289,6 +292,9 @@ void ShowSaveDialog(atom::NativeWindow* parent, const std::string& button_label, const base::FilePath& default_path, const Filters& filters, + const std::string& message, + const std::string& name_field_label, + const bool& shows_tag_field, const SaveDialogCallback& callback) { RunState run_state; if (!CreateDialogThread(&run_state)) { diff --git a/atom/browser/web_dialog_helper.cc b/atom/browser/web_dialog_helper.cc index e3942f1f717..e5bd46672fd 100644 --- a/atom/browser/web_dialog_helper.cc +++ b/atom/browser/web_dialog_helper.cc @@ -90,6 +90,9 @@ void WebDialogHelper::RunFileChooser( "", params.default_file_name, filters, + "", + "", + false, &path)) { content::FileChooserFileInfo info; info.file_path = path; diff --git a/lib/browser/api/dialog.js b/lib/browser/api/dialog.js index 85572b3b4fb..4088431c151 100644 --- a/lib/browser/api/dialog.js +++ b/lib/browser/api/dialog.js @@ -136,7 +136,8 @@ module.exports = { } } - let {buttonLabel, defaultPath, filters, title} = options + let {buttonLabel, defaultPath, filters, title, message, nameFieldLabel, + showsTagField} = options if (title == null) { title = '' @@ -160,10 +161,27 @@ module.exports = { filters = [] } + if (message == null) { + message = '' + } else if (typeof message !== 'string') { + throw new TypeError('Message must be a string') + } + + if (nameFieldLabel == null) { + nameFieldLabel = '' + } else if (typeof nameFieldLabel !== 'string') { + throw new TypeError('Name field label must be a string') + } + + if (showsTagField == null) { + showsTagField = false + } + const wrappedCallback = typeof callback === 'function' ? function (success, result) { return callback(success ? result : void 0) } : null return binding.showSaveDialog(title, buttonLabel, defaultPath, filters, + message, nameFieldLabel, showsTagField, window, wrappedCallback) }, From cc22149bebbc86c47734348153ac9672bc9f941b Mon Sep 17 00:00:00 2001 From: Tan Wang Leng Date: Wed, 1 Feb 2017 23:36:06 +0800 Subject: [PATCH 02/12] :memo: Update docs for new attributes in showSaveDialog() --- docs/api/dialog.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 00a7e92ef16..2b85ee34e5d 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -94,6 +94,10 @@ shown. * `buttonLabel` String (optional) - Custom label for the confirmation button, when left empty the default label will be used. * `filters` [FileFilter[]](structures/file-filter.md) (optional) + * `message` (optional) _macOS_ + * `nameFieldLabel` String (optional) _macOS_ - Custom label for the string displayed + in front of the filename text field. + * `showsTagField` Boolean (optional) _macOS_ * `callback` Function (optional) * `filename` String From 36209ddd90a1a54534eee88ef2d98da4758bcc77 Mon Sep 17 00:00:00 2001 From: Tan Wang Leng Date: Thu, 2 Feb 2017 00:01:01 +0800 Subject: [PATCH 03/12] :apple: Add additional options for Mac's open dialog Support an additional attributes available in macOS's NSOpenPanel: message. --- atom/browser/api/atom_api_dialog.cc | 5 +++-- atom/browser/common_web_contents_delegate.cc | 2 +- atom/browser/ui/file_dialog.h | 2 ++ atom/browser/ui/file_dialog_gtk.cc | 2 ++ atom/browser/ui/file_dialog_mac.mm | 12 ++++++++---- atom/browser/ui/file_dialog_win.cc | 2 ++ atom/browser/web_dialog_helper.cc | 1 + lib/browser/api/dialog.js | 12 ++++++++++-- 8 files changed, 29 insertions(+), 9 deletions(-) diff --git a/atom/browser/api/atom_api_dialog.cc b/atom/browser/api/atom_api_dialog.cc index 1efb78d72d2..d99480712d5 100644 --- a/atom/browser/api/atom_api_dialog.cc +++ b/atom/browser/api/atom_api_dialog.cc @@ -71,6 +71,7 @@ void ShowOpenDialog(const std::string& title, const base::FilePath& default_path, const file_dialog::Filters& filters, int properties, + const std::string& message, atom::NativeWindow* window, mate::Arguments* args) { v8::Local peek = args->PeekNext(); @@ -79,11 +80,11 @@ void ShowOpenDialog(const std::string& title, peek, &callback)) { file_dialog::ShowOpenDialog(window, title, button_label, default_path, - filters, properties, callback); + filters, properties, message, callback); } else { std::vector paths; if (file_dialog::ShowOpenDialog(window, title, button_label, default_path, - filters, properties, &paths)) + filters, properties, message, &paths)) args->Return(paths); } } diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index c3cca231c31..5b3961464cd 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -363,7 +363,7 @@ void CommonWebContentsDelegate::DevToolsAddFileSystem( std::vector paths; int flag = file_dialog::FILE_DIALOG_OPEN_DIRECTORY; if (!file_dialog::ShowOpenDialog(owner_window(), "", "", default_path, - filters, flag, &paths)) + filters, flag, "", &paths)) return; path = paths[0]; diff --git a/atom/browser/ui/file_dialog.h b/atom/browser/ui/file_dialog.h index 8b2d7f0d99e..4759e503b2a 100644 --- a/atom/browser/ui/file_dialog.h +++ b/atom/browser/ui/file_dialog.h @@ -43,6 +43,7 @@ bool ShowOpenDialog(atom::NativeWindow* parent_window, const base::FilePath& default_path, const Filters& filters, int properties, + const std::string& message, std::vector* paths); void ShowOpenDialog(atom::NativeWindow* parent_window, @@ -51,6 +52,7 @@ void ShowOpenDialog(atom::NativeWindow* parent_window, const base::FilePath& default_path, const Filters& filters, int properties, + const std::string& message, const OpenDialogCallback& callback); bool ShowSaveDialog(atom::NativeWindow* parent_window, diff --git a/atom/browser/ui/file_dialog_gtk.cc b/atom/browser/ui/file_dialog_gtk.cc index c39281d8f6e..db79ceb171b 100644 --- a/atom/browser/ui/file_dialog_gtk.cc +++ b/atom/browser/ui/file_dialog_gtk.cc @@ -236,6 +236,7 @@ bool ShowOpenDialog(atom::NativeWindow* parent_window, const base::FilePath& default_path, const Filters& filters, int properties, + const std::string& message, std::vector* paths) { GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN; if (properties & FILE_DIALOG_OPEN_DIRECTORY) @@ -260,6 +261,7 @@ void ShowOpenDialog(atom::NativeWindow* parent_window, const base::FilePath& default_path, const Filters& filters, int properties, + const std::string& message, const OpenDialogCallback& callback) { GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN; if (properties & FILE_DIALOG_OPEN_DIRECTORY) diff --git a/atom/browser/ui/file_dialog_mac.mm b/atom/browser/ui/file_dialog_mac.mm index ee07d2af004..8c88531bd1a 100644 --- a/atom/browser/ui/file_dialog_mac.mm +++ b/atom/browser/ui/file_dialog_mac.mm @@ -134,12 +134,14 @@ bool ShowOpenDialog(atom::NativeWindow* parent_window, const base::FilePath& default_path, const Filters& filters, int properties, + const std::string& message, std::vector* paths) { DCHECK(paths); NSOpenPanel* dialog = [NSOpenPanel openPanel]; -// TODO yamgent: Fix this - SetupDialog(dialog, title, button_label, default_path, filters, "", "", false); + SetupDialog(dialog, title, button_label, default_path, filters, message, + // NSOpenPanel does not support name_field_label and shows_tag_field + "", false); SetupDialogForProperties(dialog, properties); int chosen = RunModalDialog(dialog, parent_window); @@ -156,11 +158,13 @@ void ShowOpenDialog(atom::NativeWindow* parent_window, const base::FilePath& default_path, const Filters& filters, int properties, + const std::string& message, const OpenDialogCallback& c) { NSOpenPanel* dialog = [NSOpenPanel openPanel]; -// TODO yamgent: Fix this - SetupDialog(dialog, title, button_label, default_path, filters, "", "", false); + SetupDialog(dialog, title, button_label, default_path, filters, message, + // NSOpenPanel does not support name_field_label and shows_tag_field + "", false); SetupDialogForProperties(dialog, properties); // Duplicate the callback object here since c is a reference and gcd would diff --git a/atom/browser/ui/file_dialog_win.cc b/atom/browser/ui/file_dialog_win.cc index 2c801756248..dc28acb3488 100644 --- a/atom/browser/ui/file_dialog_win.cc +++ b/atom/browser/ui/file_dialog_win.cc @@ -198,6 +198,7 @@ bool ShowOpenDialog(atom::NativeWindow* parent_window, const base::FilePath& default_path, const Filters& filters, int properties, + const std::string& message, std::vector* paths) { int options = FOS_FORCEFILESYSTEM | FOS_FILEMUSTEXIST; if (properties & FILE_DIALOG_OPEN_DIRECTORY) @@ -250,6 +251,7 @@ void ShowOpenDialog(atom::NativeWindow* parent, const base::FilePath& default_path, const Filters& filters, int properties, + const std::string& message, const OpenDialogCallback& callback) { RunState run_state; if (!CreateDialogThread(&run_state)) { diff --git a/atom/browser/web_dialog_helper.cc b/atom/browser/web_dialog_helper.cc index e5bd46672fd..0e28b07525b 100644 --- a/atom/browser/web_dialog_helper.cc +++ b/atom/browser/web_dialog_helper.cc @@ -125,6 +125,7 @@ void WebDialogHelper::RunFileChooser( default_file_path, filters, flags, + "", &paths)) { for (auto& path : paths) { content::FileChooserFileInfo info; diff --git a/lib/browser/api/dialog.js b/lib/browser/api/dialog.js index 4088431c151..73a519cc20b 100644 --- a/lib/browser/api/dialog.js +++ b/lib/browser/api/dialog.js @@ -81,7 +81,8 @@ module.exports = { } } - let {buttonLabel, defaultPath, filters, properties, title} = options + let {buttonLabel, defaultPath, filters, properties, title, + message} = options if (properties == null) { properties = ['openFile'] @@ -118,11 +119,18 @@ module.exports = { filters = [] } + if (message == null) { + message = '' + } else if (typeof message !== 'string') { + throw new TypeError('Message must be a string') + } + const wrappedCallback = typeof callback === 'function' ? function (success, result) { return callback(success ? result : void 0) } : null return binding.showOpenDialog(title, buttonLabel, defaultPath, filters, - dialogProperties, window, wrappedCallback) + dialogProperties, message, window, + wrappedCallback) }, showSaveDialog: function (...args) { From 8843fef06587f6e8a91cb9c97cdae4b41deddc87 Mon Sep 17 00:00:00 2001 From: Tan Wang Leng Date: Thu, 2 Feb 2017 00:01:19 +0800 Subject: [PATCH 04/12] :memo: Update docs for new attributes in showOpenDialog() --- docs/api/dialog.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 2b85ee34e5d..1bdb5f5cc7b 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -51,6 +51,7 @@ The `dialog` module has the following methods: untouched on Windows. For example, a button label of `Vie&w` will be converted to `Vie_w` on Linux and `View` on macOS and can be selected via `Alt-W` on Windows and Linux. + * `message` (optional) _macOS_ * `callback` Function (optional) * `filePaths` String[] - An array of file paths chosen by the user From 1bf8270c0d61a6df8a9071485520a2972db00a4e Mon Sep 17 00:00:00 2001 From: Tan Wang Leng Date: Thu, 2 Feb 2017 20:21:20 +0800 Subject: [PATCH 05/12] :checkered_flag: Fix dialog method calls for Windows --- atom/browser/ui/file_dialog_win.cc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/browser/ui/file_dialog_win.cc b/atom/browser/ui/file_dialog_win.cc index dc28acb3488..365d28cbacf 100644 --- a/atom/browser/ui/file_dialog_win.cc +++ b/atom/browser/ui/file_dialog_win.cc @@ -169,7 +169,7 @@ void RunOpenDialogInNewThread(const RunState& run_state, const OpenDialogCallback& callback) { std::vector paths; bool result = ShowOpenDialog(parent, title, button_label, default_path, - filters, properties, &paths); + filters, properties, "", &paths); run_state.ui_task_runner->PostTask(FROM_HERE, base::Bind(callback, result, paths)); run_state.ui_task_runner->DeleteSoon(FROM_HERE, run_state.dialog_thread); @@ -184,7 +184,7 @@ void RunSaveDialogInNewThread(const RunState& run_state, const SaveDialogCallback& callback) { base::FilePath path; bool result = ShowSaveDialog(parent, title, button_label, default_path, - filters, &path); + filters, "", "", false, &path); run_state.ui_task_runner->PostTask(FROM_HERE, base::Bind(callback, result, path)); run_state.ui_task_runner->DeleteSoon(FROM_HERE, run_state.dialog_thread); From b0487b7d8431bf38d351f38f940bf9d468bc8423 Mon Sep 17 00:00:00 2001 From: Tan Wang Leng Date: Thu, 2 Feb 2017 21:01:02 +0800 Subject: [PATCH 06/12] Fix wrong signature for gtk's ShowSaveDialog() --- atom/browser/ui/file_dialog_gtk.cc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/atom/browser/ui/file_dialog_gtk.cc b/atom/browser/ui/file_dialog_gtk.cc index db79ceb171b..54e32cdf7d1 100644 --- a/atom/browser/ui/file_dialog_gtk.cc +++ b/atom/browser/ui/file_dialog_gtk.cc @@ -298,6 +298,9 @@ void ShowSaveDialog(atom::NativeWindow* parent_window, const std::string& button_label, const base::FilePath& default_path, const Filters& filters, + const std::string& message, + const std::string& name_field_label, + const bool& shows_tag_field, const SaveDialogCallback& callback) { FileChooserDialog* save_dialog = new FileChooserDialog( GTK_FILE_CHOOSER_ACTION_SAVE, parent_window, title, button_label, From 9423143211bc2368a8db188c9381927215228c86 Mon Sep 17 00:00:00 2001 From: Tan Wang Leng Date: Thu, 9 Feb 2017 21:01:40 +0800 Subject: [PATCH 07/12] Change the default value of showsTagField to true The default value of showsTagField in macOS's NSSavePanel is true. Therefore, in order to follow the standard behavior and not break backwards-compatibility, let's change the default value of showsTagField to true. Reference: https://developer.apple.com/reference/appkit/nssavepanel/1525589-showstagfield?language=objc --- lib/browser/api/dialog.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/browser/api/dialog.js b/lib/browser/api/dialog.js index 73a519cc20b..e046eadc16a 100644 --- a/lib/browser/api/dialog.js +++ b/lib/browser/api/dialog.js @@ -182,7 +182,7 @@ module.exports = { } if (showsTagField == null) { - showsTagField = false + showsTagField = true } const wrappedCallback = typeof callback === 'function' ? function (success, result) { From 72723646dd7719f57cf13eb1ea5b9d448f868f99 Mon Sep 17 00:00:00 2001 From: Tan Wang Leng Date: Thu, 9 Feb 2017 21:23:02 +0800 Subject: [PATCH 08/12] Add tests to check errors in parameters --- spec/api-dialog-spec.js | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/spec/api-dialog-spec.js b/spec/api-dialog-spec.js index 9b90b0353dc..a07548e9535 100644 --- a/spec/api-dialog-spec.js +++ b/spec/api-dialog-spec.js @@ -19,6 +19,10 @@ describe('dialog module', () => { assert.throws(() => { dialog.showOpenDialog({defaultPath: {}}) }, /Default path must be a string/) + + assert.throws(() => { + dialog.showOpenDialog({message: {}}) + }, /Message must be a string/) }) }) @@ -35,6 +39,14 @@ describe('dialog module', () => { assert.throws(() => { dialog.showSaveDialog({defaultPath: {}}) }, /Default path must be a string/) + + assert.throws(() => { + dialog.showSaveDialog({message: {}}) + }, /Message must be a string/) + + assert.throws(() => { + dialog.showSaveDialog({nameFieldLabel: {}}) + }, /Name field label must be a string/) }) }) From a4a71a1dc985dd8a48b3bcfb871bf65140885353 Mon Sep 17 00:00:00 2001 From: Tan Wang Leng Date: Thu, 9 Feb 2017 21:33:33 +0800 Subject: [PATCH 09/12] Change qualifier of ShowSaveDialog() parameter The normal convention in the codebase is to not use references or 'const' for primitives like 'bool' and 'int'. --- atom/browser/api/atom_api_dialog.cc | 2 +- atom/browser/ui/file_dialog.h | 4 ++-- atom/browser/ui/file_dialog_gtk.cc | 4 ++-- atom/browser/ui/file_dialog_mac.mm | 4 ++-- atom/browser/ui/file_dialog_win.cc | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/atom/browser/api/atom_api_dialog.cc b/atom/browser/api/atom_api_dialog.cc index d99480712d5..5f0b7fec5fa 100644 --- a/atom/browser/api/atom_api_dialog.cc +++ b/atom/browser/api/atom_api_dialog.cc @@ -95,7 +95,7 @@ void ShowSaveDialog(const std::string& title, const file_dialog::Filters& filters, const std::string& message, const std::string& name_field_label, - const bool& shows_tag_field, + bool shows_tag_field, atom::NativeWindow* window, mate::Arguments* args) { v8::Local peek = args->PeekNext(); diff --git a/atom/browser/ui/file_dialog.h b/atom/browser/ui/file_dialog.h index 4759e503b2a..546722b4e6e 100644 --- a/atom/browser/ui/file_dialog.h +++ b/atom/browser/ui/file_dialog.h @@ -62,7 +62,7 @@ bool ShowSaveDialog(atom::NativeWindow* parent_window, const Filters& filters, const std::string& message, const std::string& name_field_label, - const bool& shows_tag_field, + bool shows_tag_field, base::FilePath* path); void ShowSaveDialog(atom::NativeWindow* parent_window, @@ -72,7 +72,7 @@ void ShowSaveDialog(atom::NativeWindow* parent_window, const Filters& filters, const std::string& message, const std::string& name_field_label, - const bool& shows_tag_field, + bool shows_tag_field, const SaveDialogCallback& callback); } // namespace file_dialog diff --git a/atom/browser/ui/file_dialog_gtk.cc b/atom/browser/ui/file_dialog_gtk.cc index 54e32cdf7d1..f4aaa380372 100644 --- a/atom/browser/ui/file_dialog_gtk.cc +++ b/atom/browser/ui/file_dialog_gtk.cc @@ -279,7 +279,7 @@ bool ShowSaveDialog(atom::NativeWindow* parent_window, const Filters& filters, const std::string& message, const std::string& name_field_label, - const bool& shows_tag_field, + bool shows_tag_field, base::FilePath* path) { FileChooserDialog save_dialog(GTK_FILE_CHOOSER_ACTION_SAVE, parent_window, title, button_label, default_path, filters); @@ -300,7 +300,7 @@ void ShowSaveDialog(atom::NativeWindow* parent_window, const Filters& filters, const std::string& message, const std::string& name_field_label, - const bool& shows_tag_field, + bool shows_tag_field, const SaveDialogCallback& callback) { FileChooserDialog* save_dialog = new FileChooserDialog( GTK_FILE_CHOOSER_ACTION_SAVE, parent_window, title, button_label, diff --git a/atom/browser/ui/file_dialog_mac.mm b/atom/browser/ui/file_dialog_mac.mm index 8c88531bd1a..e916f8d23db 100644 --- a/atom/browser/ui/file_dialog_mac.mm +++ b/atom/browser/ui/file_dialog_mac.mm @@ -191,7 +191,7 @@ bool ShowSaveDialog(atom::NativeWindow* parent_window, const Filters& filters, const std::string& message, const std::string& name_field_label, - const bool& shows_tag_field, + bool shows_tag_field, base::FilePath* path) { DCHECK(path); NSSavePanel* dialog = [NSSavePanel savePanel]; @@ -214,7 +214,7 @@ void ShowSaveDialog(atom::NativeWindow* parent_window, const Filters& filters, const std::string& message, const std::string& name_field_label, - const bool& shows_tag_field, + bool shows_tag_field, const SaveDialogCallback& c) { NSSavePanel* dialog = [NSSavePanel savePanel]; diff --git a/atom/browser/ui/file_dialog_win.cc b/atom/browser/ui/file_dialog_win.cc index 365d28cbacf..7b5a1f4897b 100644 --- a/atom/browser/ui/file_dialog_win.cc +++ b/atom/browser/ui/file_dialog_win.cc @@ -272,7 +272,7 @@ bool ShowSaveDialog(atom::NativeWindow* parent_window, const Filters& filters, const std::string& message, const std::string& name_field_label, - const bool& shows_tag_field, + bool shows_tag_field, base::FilePath* path) { FileDialog save_dialog( default_path, title, button_label, filters, @@ -296,7 +296,7 @@ void ShowSaveDialog(atom::NativeWindow* parent, const Filters& filters, const std::string& message, const std::string& name_field_label, - const bool& shows_tag_field, + bool shows_tag_field, const SaveDialogCallback& callback) { RunState run_state; if (!CreateDialogThread(&run_state)) { From 347dc835b584917db72eb46d189f7a7a6cad0aff Mon Sep 17 00:00:00 2001 From: Tan Wang Leng Date: Thu, 9 Feb 2017 21:47:26 +0800 Subject: [PATCH 10/12] Fix code formatting --- atom/browser/ui/file_dialog_mac.mm | 10 ++++------ lib/browser/api/dialog.js | 3 +-- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/atom/browser/ui/file_dialog_mac.mm b/atom/browser/ui/file_dialog_mac.mm index e916f8d23db..70d5694562b 100644 --- a/atom/browser/ui/file_dialog_mac.mm +++ b/atom/browser/ui/file_dialog_mac.mm @@ -139,9 +139,8 @@ bool ShowOpenDialog(atom::NativeWindow* parent_window, DCHECK(paths); NSOpenPanel* dialog = [NSOpenPanel openPanel]; - SetupDialog(dialog, title, button_label, default_path, filters, message, - // NSOpenPanel does not support name_field_label and shows_tag_field - "", false); + // NSOpenPanel does not support name_field_label and shows_tag_field + SetupDialog(dialog, title, button_label, default_path, filters, message, "", false); SetupDialogForProperties(dialog, properties); int chosen = RunModalDialog(dialog, parent_window); @@ -162,9 +161,8 @@ void ShowOpenDialog(atom::NativeWindow* parent_window, const OpenDialogCallback& c) { NSOpenPanel* dialog = [NSOpenPanel openPanel]; - SetupDialog(dialog, title, button_label, default_path, filters, message, - // NSOpenPanel does not support name_field_label and shows_tag_field - "", false); + // NSOpenPanel does not support name_field_label and shows_tag_field + SetupDialog(dialog, title, button_label, default_path, filters, message, "", false); SetupDialogForProperties(dialog, properties); // Duplicate the callback object here since c is a reference and gcd would diff --git a/lib/browser/api/dialog.js b/lib/browser/api/dialog.js index e046eadc16a..b000e46e150 100644 --- a/lib/browser/api/dialog.js +++ b/lib/browser/api/dialog.js @@ -81,8 +81,7 @@ module.exports = { } } - let {buttonLabel, defaultPath, filters, properties, title, - message} = options + let {buttonLabel, defaultPath, filters, properties, title, message} = options if (properties == null) { properties = ['openFile'] From 35654d872b544699a5f065a66371c6f652513bbb Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Thu, 9 Feb 2017 11:29:10 -0800 Subject: [PATCH 11/12] Document new settings --- docs/api/dialog.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 10326731aa1..75edc26bdc8 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -51,7 +51,8 @@ The `dialog` module has the following methods: untouched on Windows. For example, a button label of `Vie&w` will be converted to `Vie_w` on Linux and `View` on macOS and can be selected via `Alt-W` on Windows and Linux. - * `message` (optional) _macOS_ + * `message` String (optional) _macOS_ - Message to display above input + boxes. * `callback` Function (optional) * `filePaths` String[] - An array of file paths chosen by the user @@ -95,10 +96,11 @@ shown. * `buttonLabel` String (optional) - Custom label for the confirmation button, when left empty the default label will be used. * `filters` [FileFilter[]](structures/file-filter.md) (optional) - * `message` (optional) _macOS_ - * `nameFieldLabel` String (optional) _macOS_ - Custom label for the string displayed - in front of the filename text field. - * `showsTagField` Boolean (optional) _macOS_ + * `message` String (optional) _macOS_ - Message to display above text fields. + * `nameFieldLabel` String (optional) _macOS_ - Custom label for the text + displayed in front of the filename text field. + * `showsTagField` Boolean (optional) _macOS_ - Show the tags input box, + defaults to `true`. * `callback` Function (optional) * `filename` String From 5130ad24eb81f3e08db938e6549282a7c04d2bee Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Thu, 9 Feb 2017 11:30:17 -0800 Subject: [PATCH 12/12] :art: --- lib/browser/api/dialog.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/lib/browser/api/dialog.js b/lib/browser/api/dialog.js index 2bee42eb410..285ca72901c 100644 --- a/lib/browser/api/dialog.js +++ b/lib/browser/api/dialog.js @@ -143,8 +143,7 @@ module.exports = { } } - let {buttonLabel, defaultPath, filters, title, message, nameFieldLabel, - showsTagField} = options + let {buttonLabel, defaultPath, filters, title, message, nameFieldLabel, showsTagField} = options if (title == null) { title = ''